Skip navigation links

oracle.search.sdk.common
Class ParameterInfo

java.lang.Object
oracle.search.sdk.common.ParameterInfo

public class ParameterInfo

extends java.lang.Object

A class for describing the general properties of a parameter.

Constructor Summary

ParameterInfo(java.lang.String name, java.lang.String description, java.lang.String defaultValue, boolean encrypted)
Constructs a parameter information instance

Method Summary

java.lang.String	getDefaultValue() Returns the default value of the parameter
java.lang.String	getDescription() Returns the description of the parameter
java.lang.String	getName() Returns the name of the parameter
boolean	isEncrypted() should this parameter value be encrypted?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParameterInfo

public ParameterInfo(java.lang.String name,
                     java.lang.String description,
                     java.lang.String defaultValue,
                     boolean encrypted)

Constructs a parameter information instance

Parameters:

name - parameter name

description - parameter description

defaultValue - parameter default value

encrypted - should the parameter value be encrypted

Method Detail

getName

public java.lang.String getName()

Returns the name of the parameter

Returns:

the name of this parameter

getDescription

public java.lang.String getDescription()

Returns the description of the parameter

Returns:

the description of this parameter

getDefaultValue

public java.lang.String getDefaultValue()

Returns the default value of the parameter

Returns:

the default value of this parameter. Returns null if there is no default value.

isEncrypted

public boolean isEncrypted()

should this parameter value be encrypted?

Returns:

true if encrypted, false if not encrypted

Skip navigation links