com.wrq.apptrieve.appconn
Class VariableMetaData

java.lang.Object
  extended by com.wrq.apptrieve.appconn.VariableMetaData
All Implemented Interfaces:
AppConnMetaData

public class VariableMetaData
extends java.lang.Object
implements AppConnMetaData

Provides metadata about a model variable that is defined in a Host Integrator model.


Field Summary
static int INIT_TYPE_AT_CONNECTION
          Return value for getInitType() when variable is set to Initialize at Host Connect.
static int INIT_TYPE_BY_DEFAULT
          Return value for getInitType() when variable is set to Initialize with Default Value.
static int INIT_TYPE_UNINITIALIZED
          Return value for getInitType() when variable is set to Not Initialized.
static int VAR_KIND_SETTING
          Return value for getKind() when variable is mapped to a setting.
static int VAR_KIND_USER
          Return value for getKind() when variable is not mapped to a setting.
 
Fields inherited from interface com.wrq.apptrieve.appconn.AppConnMetaData
METADATA_TYPE_ATTRIBUTE, METADATA_TYPE_COLUMN, METADATA_TYPE_FIELD, METADATA_TYPE_OPERATION, METADATA_TYPE_PROCEDURE, METADATA_TYPE_RECORDSET, METADATA_TYPE_VARIABLE
 
Constructor Summary
VariableMetaData(com.wrq.apptrieve.agent.ModelVariableMeta saObject)
          Constructor for internal use only.
 
Method Summary
 java.lang.String getDefaultValue()
          Gets the default value for the variable.
 java.lang.String getDescription()
          Gets the description for the variable.
 int getInitType()
          Gets the initialization type of the variable.
 int getKind()
          Gets the kind of the variable.
 int getMetaDataType()
          Gets the meta data type for this object.
 java.lang.String getName()
          Gets the name of the variable.
 boolean isEncrypted()
          Discovers whether the variable is encrypted.
 boolean isHidden()
          Discovers whether the variable is hidden.
 boolean isReadable()
          Discovers whether the variable value can be read.
 boolean isWriteable()
          Discovers whether the variable value can be changed.
 java.lang.String toString()
          Generates a String object that represents the current values of this VariableMetaData object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

INIT_TYPE_AT_CONNECTION

public static final int INIT_TYPE_AT_CONNECTION
Return value for getInitType() when variable is set to Initialize at Host Connect.

See Also:
Constant Field Values

INIT_TYPE_BY_DEFAULT

public static final int INIT_TYPE_BY_DEFAULT
Return value for getInitType() when variable is set to Initialize with Default Value.

See Also:
Constant Field Values

INIT_TYPE_UNINITIALIZED

public static final int INIT_TYPE_UNINITIALIZED
Return value for getInitType() when variable is set to Not Initialized.

See Also:
Constant Field Values

VAR_KIND_SETTING

public static final int VAR_KIND_SETTING
Return value for getKind() when variable is mapped to a setting.

See Also:
Constant Field Values

VAR_KIND_USER

public static final int VAR_KIND_USER
Return value for getKind() when variable is not mapped to a setting.

See Also:
Constant Field Values
Constructor Detail

VariableMetaData

public VariableMetaData(com.wrq.apptrieve.agent.ModelVariableMeta saObject)
Constructor for internal use only.

Parameters:
saObject - data
Method Detail

getDefaultValue

public java.lang.String getDefaultValue()
Gets the default value for the variable.

Returns:
String the default value

getDescription

public java.lang.String getDescription()
Gets the description for the variable.

Specified by:
getDescription in interface AppConnMetaData
Returns:
String the description

getInitType

public int getInitType()
Gets the initialization type of the variable.

The returned value is one of:

Returns:
int - the initialization type of the variable

getKind

public int getKind()
Gets the kind of the variable. This setting corresponds to the "Map to setting" control in the Design Tool's Variables dialog. If the value is "(None)", this method returns VAR_KIND_USER. Otherwise, the method returns VAR_KIND_SETTING

The returned value is one of:

Returns:
int - the kind of the variable

getMetaDataType

public int getMetaDataType()
Gets the meta data type for this object.

Specified by:
getMetaDataType in interface AppConnMetaData
Returns:
int - always returns AppConnMetaData.METADATA_TYPE_VARIABLE

getName

public java.lang.String getName()
Gets the name of the variable.

Specified by:
getName in interface AppConnMetaData
Returns:
String the name

isEncrypted

public boolean isEncrypted()
Discovers whether the variable is encrypted.

Returns:
boolean true if the variable is encrypted

isHidden

public boolean isHidden()
Discovers whether the variable is hidden.

Returns:
boolean true if the variable is hidden

isReadable

public boolean isReadable()
Discovers whether the variable value can be read.

Returns:
boolean true if the variable value can be read

isWriteable

public boolean isWriteable()
Discovers whether the variable value can be changed.

Returns:
boolean true if the variable value can be changed

toString

public java.lang.String toString()
Generates a String object that represents the current values of this VariableMetaData object.

Overrides:
toString in class java.lang.Object
Returns:
java.lang.String - the string representation of this object