Skip navigation links

oracle.search.sdk.crawler
Class ParameterInfo

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

public class ParameterInfo

extends Object

ParameterInfo is a class for describing the general properties of a parameter.

Constructor Summary

ParameterInfo(String name, String description, String defaultValue, boolean encrypted)
Construct a parameter information instance.

Method Summary

String	getDefaultValue() Gets the default value of the parameter.
String	getDescription() Gets the description of the parameter.
String	getName() Gets the name of the parameter.
boolean	isEncrypted() Should this parameter value be encrypted?

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterInfo

public ParameterInfo(String name,
                     String description,
                     String defaultValue,
                     boolean encrypted)

Construct 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 String getName()

Gets the name of the parameter.

Returns:

The name of this parameter.

getDescription

public String getDescription()

Gets the description of the parameter.

Returns:

The description of this parameter.

getDefaultValue

public String getDefaultValue()

Gets the default value of the parameter.

Returns:

The default value of this parameter, or null if there is no default value.

isEncrypted

public boolean isEncrypted()

Should this parameter value be encrypted?

Returns:

A value of true for encryption, or false for no encryption.

Skip navigation links