Skip navigation links

Oracle Secure Enterprise Search Java API Reference
11g Release 1 (11.1.2.0.0)

E14433-02


oracle.search.sdk.common
Class ParameterInfo

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


public class ParameterInfo
extends Object

A class for describing the general properties of a parameter.


Constructor Summary
ParameterInfo(String name, String description, String defaultValue, boolean encrypted)
          Constructs a parameter information instance

 

Method Summary
 String getDefaultValue()
          Returns the default value of the parameter
 String getDescription()
          Returns the description of the parameter
 String getName()
          Returns 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)
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 String getName()
Returns the name of the parameter
Returns:
the name of this parameter

getDescription

public String getDescription()
Returns the description of the parameter
Returns:
the description of this parameter

getDefaultValue

public 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

Oracle Secure Enterprise Search Java API Reference
11g Release 1 (11.1.2.0.0)

E14433-02


Copyright © 2006, 2010, Oracle and/or its affiliates. All rights reserved.