Member variables

Table 68 summarizes the member variables of the AgentProperty class.

Table 68. Member variables of the AgentProperty class.

Member variable Description Page
allDefaultValues Specifies the default values to display for the agent property. allDefaultValues
allDependencies Specifies the conditions that describe the dependencies between this agent property and other dependent properties. allDependencies
allValidValues Specifies the value values to display for the agent property. allValidValues
allValues Stores the values that the user selects for the agent property. allValues
cardinality Specifies whether the agent property can hold one or multiple values. cardinality
description Provides a textual explanation of the agent property and might hold other relevant information. description
isHidden Determines whether the value of the agent property must display as encrypted. isHidden
isMultiple Determines whether Business Object Wizard provides a mechanism for user entry of multiple values for the agent-property value. isMultiple
isReadOnly Determines whether a user can specify a value for the agent property or can only view the property value. isReadOnly
isRequired Determines whether a value must always be specified for the agent property. isRequired
propName Specifies the name of the agent property. propName
type Specifies the data type of the agent property. type

allDefaultValues

Specifies the default values to display for the agent property.

Type

public java.lang.Object[] allDefaultValues

Notes

The allDefaultValues member variable contains an array of default values for the agent property. The number of Object elements in this array must correspond to the cardinality of the property, as follows:

For more information, see Specifying default values.

allDependencies

Specifies a list of conditions that describe the dependencies between this agent property and other dependent properties.

Type

public CompleteCondition[] allDependencies

Notes

The allDependencies member variable contains a list of conditions in the condition array, which is an array of CompleteCondition objects. Each CompleteCondition object contains one condition on the agent property's value. A condition contains input and dependency conditions. For more information, see Setting conditions on the property value.

allValidValues

Specifies the valid values to display for the agent property.

Type

public java.lang.Object[] allValidValues

Notes

The allValidValues member variable contains a list of values with which to initialize the drop-down list of an agent property. From this drop-down list, the user can choose one (single cardinality) or more (multiple cardinality) values for the property.

If allValidValues specifies a list of values, Business Object Wizard displays these values in the drop-down list for any agent property whose isMultiple member variable is true. If isHidden is true and allValidValues is null, Business Object Wizard displays a sub-grid for users to specify values.

Note:
If the isMultiple member variable is false, the allValidValues member variable should be null.

For more information, see Choosing the type of display control.

allValues

Stores the values that the user provides for the agent property.

Type

public java.lang.Object[] allValues

Notes

The allValues member variable is an output variable; that is, it is populated by Business Object Wizard after user entry is complete. It contains the values that the user selects from the Value column in the Configure Agent step of Business Object Wizard. This variable is the only member variable that does not require initialization before the agent property displays to the user.

The number of values in the allValues array is determined by the agent property's cardinality:

cardinality

Specifies whether the agent property can hold one or multiple values.

Type

public java.lang.String cardinality

Notes

The cardinality member variable determines whether an agent property's value consists of a single value or multiple values. Therefore, it determines how many values the user can specify for the property.

Cardinality Number of agent-property values the user can specify Value of cardinality member variable
Single One ODKConstant.SINGLE_CARD
Multiple Many ODKConstant.MULTIPLE_CARD

The property's cardinality has an effect on the type of control that Business Object Wizard displays for the property. For more information, see Choosing the type of display control.

To initialize an agent property's cardinality, the following call to the third form of the AgentProperty() constructor specifies a string description value as the sixth argument:

AgentProperty agt = new AgentProperty("Username",
         AgentProperty.TYPE_STRING,
         "User Id for logging into the database", true, false,
         ODKConstant.SINGLE_CARD, null, null);

Note:
You can also specify a value for the agent property's cardinality with the second form of the AgentProperty() constructor, using its eighth argument.

description

Provides a textual explanation of the agent property and may hold other relevant information.

Type

public java.lang.String description;

Notes

The description member variable displays in the Description column in the Configure Agent step of Business Object Wizard. To initialize an agent property's description, the following call to the third form of the AgentProperty() constructor specifies a string description value as the third argument:

AgentProperty agt = new AgentProperty("Username",
         AgentProperty.TYPE_STRING,
         "User Id for logging into the database", true, false,
         ODKConstant.SINGLE_CARD, null, null);

Note:
You can also specify a value for the agent property's description with the second form of the AgentProperty() constructor, using its sixth argument.

isHidden

Determines whether the value of the agent property should display as encrypted.

Type

public boolean isHidden;

Notes

The isHidden member variable is a boolean value that determines whether an agent property's value displays in Business Object Wizard. If isHidden is true, the agent property's value is encrypted when it displays; that is, the value appears as a string of asterisk (*) characters. To indicate whether an agent property's value is encrypted, specify a boolean value as the fourth argument in the second form of the AgentProperty() constructor:

AgentProperty agt = new AgentProperty("Username",
         AgentProperty.TYPE_STRING, true, false, true,
         "User Id for logging into the database", true,
         ODKConstant.SINGLE_CARD, null, null);

isMultiple

Determines whether Business Object Wizard provides a means to enter multiple values for an agent property.

Type

public boolean isMultiple;

Notes

The isMultiple member variable is a boolean value that determines whether Business Object Wizard should provide a mechanism for allowing user entry of multiple values for an agent property:

Note:
For more information, see Choosing the type of display control.

To initialize an agent property with a list of multiple values for the user to choose from, the following call to the third form of the AgentProperty() constructor specifies a boolean value of true as the fourth argument (the value of the isMultiple variable):

AgentProperty agt = new AgentProperty("Username",
         AgentProperty.TYPE_STRING,
         "User Id for logging into the database", true, true,
         ODKConstant.SINGLE_CARD, null, null);

Note:
You can also specify a value for isMultiple with the second form of the AgentProperty() constructor, using its seventh argument.

isReadOnly

Determines whether the user can specify a value in the agent property or can only view the value.

Type

public boolean isReadOnly;

Notes

The isReadOnly member variable is a boolean value that determines whether an agent property's value can be modified by the user when the property displays in Business Object Wizard. To indicate whether an agent property's value is required, specify a boolean value as the fifth argument in the second form of the AgentProperty() constructor:

AgentProperty agt = new AgentProperty("Username",
         AgentProperty.TYPE_STRING, true, false, true,
         "User Id for logging into the database", true,
         ODKConstant.SINGLE_CARD, null, null);

isRequired

Determines whether a value is required for the agent property.

Type

public boolean isRequired;

Notes

The isRequired member variable is a boolean value that determines whether a value must always be specified for the agent property or whether the user can leave the property's value empty. If isRequired is true, the user must provide a value for this property. To indicate that an agent property's value is required, the following call to the third form of the AgentProperty() constructor specifies a boolean value of true as the fourth argument:

AgentProperty agt = new AgentProperty("Username",
         AgentProperty.TYPE_STRING,
         "User Id for logging into the database", true, false,
         ODKConstant.SINGLE_CARD, null, null);

Note:
You can also specify a value for isRequired with the second form of the AgentProperty() constructor, using its third argument.

propName

Specifies the name of the agent property.

Type

public java.lang.String propName;

Notes

The propName member variable contains a string with the name of the agent property--for example: Username, Password, DatabaseUrl. The value of the propName member variable displays in the Property column in the Configure Agent step of Business Object Wizard. To initialize an agent property's name, the following call to the third form of the AgentProperty() constructor specifies a name as the first argument:

AgentProperty agt = new AgentProperty("Username",
         AgentProperty.TYPE_STRING,
         "User Id for logging into the database", true, false,
         ODKConstant.SINGLE_CARD, null, null);

Note:
All forms of the AgentProperty() constructor require that you specify a property name to initialize the propName member variable.

type

Specifies the type of the agent property.

Type

public int type;

Notes

The type member variable contains an integer value that represents the data type of the agent property. Table 67 lists the property-type constants to use to represent valid property types. A string representation of the type member variable's value displays in the Type column in the Configure Agent step of Business Object Wizard. To initialize an agent property's data type, specify a property-type constant as the second argument in the AgentProperty() constructor:

AgentProperty agt = new AgentProperty("Username",
         AgentProperty.TYPE_STRING,
         "User Id for logging into the database", true, false,
         ODKConstant.SINGLE_CARD, null, null);

Copyright IBM Corp. 1997, 2003