In the following section, there is a subsection entitled "Properties of an <object>" for all modules that contain functions for a specific object type. The table present in this subsection contains all the properties of objects of the named object type. The meanings of the columns are as follows:
The column "Keyword (key) in MC-CLI" contains the names by which the properties are identified in the MC- CLI.
The column "Field name in the GUI" contains the property names used in the Management Console GUI and online help system.
The "Funct." column has the following meaning:
c
(create)
Property can be specified in
create()
cd
(create/default)
Property can be specified in
create()
. If it is not specified, a default value is set.cm
(create/mandatory)
Property must be specified in
create()
. If it is not specified, aBcParameterException
is thrown.g
(get)
Property is returned by
getProperties()
m
(modify)
Property can be modified in
modifyProperties()
m(s)
(modify/synchronize)
(only for resource adapters in clusters) Property can be modified in
modifyProperties()
; all the resource adapters in the cluster are synchronized on saving.The "Property value" column contains the values permitted for a property. The variables have the following meanings:
(String)
String
(String numeric)
String that consists only of numbers
BcDef.<prop>_xxx
Values that are defined in the Java class
BcDef
and start with "<prop>_
", (e.g.BcDef.BOOL_xxx
forBcDef.BOOL_TRUE
andBcDef.BOOL_FALSE)
The specification None
is not permitted for a property value. Specifying an empty string deletes the previous values of a property.