Table 73 summarizes the member methods of the BusObjAttr class.
Member method | Description | Page |
---|---|---|
BusObjAttr() | Creates a business-object-attribute object. | BusObjAttr() |
getAppText() | Retrieves the application-specific information of an attribute. | getAppText() |
getAttrType() | Retrieves the type of a simple attribute. | getAttrType() |
getAttrTypeName() | Retrieves the type of the child business object as the type of an attribute, for an attribute that represents a child business object or an array of child business objects. | getAttrTypeName() |
getBOVersion() | Retrieves the version number of the business object definition, for an attribute that represents a child business object or an array of child business objects. | getBOVersion() |
getCardinality() | Retrieves the cardinality of the attribute, for an attribute that represents a child business object or an array of child business objects. | getCardinality() |
getComments() | Retrieves the comments associated with the attribute. | getComments() |
getDefault() | Retrieves the default value for an attribute. | getDefault() |
getMaxLength() | Retrieves the maximum length for this attribute. | getMaxLength() |
getName() | Retrieves the name of an attribute. | getName() |
getRelationType() | Retrieves the attribute's relationship type, which is containment for an attribute that represents a child business object or an array of child business objects. | getRelationType() |
isForeignKey() | Determines whether this attribute is part of the business object's foreign key. | isForeignKey() |
isKey() | Determines whether this attribute is part of the business object's key. | isKey() |
isRequiredKey() | Determines whether this attribute is part of the business object's required key. | isRequiredKey() |
isRequiredServerBound() | Determines whether an attribute is required when the business object represents a triggering event. | isRequiredServerBound() |
isSimpleType() | Determines whether an attribute is of a simple type (such as String, Integer, or Float) or whether it represents a child business object or an array of child business objects. | isSimpleType() |
setAppText() | Sets the application-specific information of an attribute. | setAppText() |
setAttrType() | Sets the type of the attribute. | setAttrType() |
setBOVersion() | Sets the version of the child business object or objects that is represented by an attribute, for an attribute that represents a child business object or an array of child business objects. | setBOVersion() |
setCardinality() | Sets the cardinality of the attribute, for an attribute that represents a child business object or an array of child business objects. | setCardinality() |
setComments() | Sets the comments associated with the attribute. | setComments() |
setDefault() | Sets the default value for an attribute. | setDefault() |
setIsForeignKey() | Sets the attribute to a boolean value that indicates whether the attribute is part of a foreign key. | setIsForeignKey() |
setIsKey() | Sets the attribute to a boolean value that indicates whether the attribute is part of a key. | setIsKey() |
setIsRequiredKey() | Sets the attribute to a boolean value that indicates whether the attribute is part of the business object's required key. | setIsRequiredKey() |
setMaxLength() | Sets the maximum length for an attribute. | setMaxLength() |
setName() | Sets the name of an attribute. | setName() |
setRelationType() | Sets the relationship type of an attribute to containment, for an attribute that represents a child business object or an array of child business objects. | setRelationType() |
public BusObjAttr(String name, int type);
public BusObjAttr(String name, int type, String typeName);
public BusObjAttr(String name, int type, String typeName, boolean isKey, boolean isForeignKey, boolean isReqd, String appSpecInfo, int maxLen, String defaultValue, String BOversion, String cardinality, String relType, boolean isReqdServerBound, String comments);
The newly instantiated BusObjAttr object.
public String getAppText();
None.
A String that contains the application-specific information of an attribute.
public int getAttrType();
None.
An integer that represents the type of the attribute. Compare this integer value with the one of the attribute-type constants:
public String getAttrTypeName();
None.
A String that contains the name of the business object definition that is the type of the child business object (when the attribute contains a child business object).
The getAttrTypeName() method retrieves the name of the attribute type for a child business object. When an attribute represents a child business object (or an array of child business objects), its attribute type isBusObjAttrType.OBJECT and its attribute type name is the name of the business object definition for the child business object.
Retrieves the version number of the business object definition, for an attribute that represents a child business object or an array of child business objects.
public String getBOVersion();
None.
A String that contains the version number of the child business object definition represented by the attribute.
Retrieves the cardinality of the attribute, for an attribute that represents a child business object or an array of child business objects.
public String getCardinality();
None.
A String that contains the cardinality of an attribute that represents a child business object or array of child business objects. Compare this string value with the following cardinality constants:
public String getComments();
None.
A String that contains the comments for an attribute.
public String getDefault();
None.
A String that contains the default value for an attribute.
public int getMaxLength();
None.
An integer that represents the maximum length of an attribute's value.
public String getName();
None.
A String that contains the name of an attribute.
Retrieves the attribute's relationship type, which is containment for an attribute that represents a child business object or an array of child business objects.
public String getRelationType();
None.
A String that contains the relationship type ("containment") of an attribute that represents a child business object or an array of child business objects.
public boolean isForeignKey();
None.
Returns true, if the attribute is a foreign key or part of the foreign key; otherwise, returns false.
public boolean isKey();
None.
Returns true, if the attribute is a key or part of the key; otherwise, returns false.
public boolean isRequiredKey();
None.
Returns true, if the attribute is a required key or part of a required key; otherwise, returns false.
public boolean isRequiredServerBound();
None.
Returns true, if the attribute is required when the business object represents a collaboration object request; otherwise, returns false.
public boolean isSimpleType();
None.
Returns true, if the attribute is of a simple type; otherwise, returns false.
public void setAppText(String appInfo);
None.
public void setAttrType(int type);
public void setAttrType(int type, String typeName);
BusObjAttrType.BOOLEAN BusObjAttrType.CIPHERTEXT BusObjAttrType.DATE BusObjAttrType.DOUBLE BusObjAttrType.FLOAT BusObjAttrType.INTEGER BusObjAttrType.LONGTEXT BusObjAttrType.OBJECT BusObjAttrType.STRING
None.
Thrown if the type is invalid; that is, it is not one of the values represented by the attribute-type constants.
The setAttrType() method provides the following forms:
getAttrType(), getAttrTypeName()
For related reference information, see BusObjAttrType interface and ODKException class.
Sets the version number of the business object definition, for an attribute that represents a child business object or an array of child business objects.
public void setBOVersion(String version);
None.
Sets the cardinality of the attribute, for an attribute that represents a child business object or an array of child business objects.
public void setCardinality(String cardinality);
None.
Thrown if the cardinality is not a valid; that is, it does not contain a valid cardinality constant.
public void setComments(String comment);
None.
public void setDefault(String defaultValue);
None.
public void setIsForeignKey(boolean fKey);
None.
public void setIsKey(boolean key);
None.
Sets the attribute to a boolean value that indicates whether the attribute is part of the business object's required key.
public void setIsRequiredKey(boolean isReqd);
None.
public void setMaxLength(int maxLength);
None.
Thrown if the maximum length is maxLength < 0 or maxLength > 2^31-1
public void setName(String name);
None.
Sets the relationship type of an attribute to containment, for an attribute that represents a child business object or an array of child business objects.
public void setRelationType(String relType);
None.