BusinessObjectInterface interface

The BusinessObjectInterface interface gives a view of the business object to the developers of low-level Java connectors. It is part of the CxCommon package. The interface defines methods for getting information about the meta-data of the business object, and methods for reading and modifying the business object instance. Each instance of BusinessObjectInterface represents a single business object.

Note:
The CWConnectorBusObj class is the Java connector library class that provides the functionality for the BusinessObjectInterface interface of the low-level Java connector library. Most Java-connector development should use the Java connector library. For more information on the classes of the Java connector library, see Overview of the Java connector library.
Important:
The low-level Java connector library provides an implementation of this interface internally. Connector developers should not implement this class.

Table 142 summarizes the methods in the BusinessObjectInterface interface.

Table 142.

Member methods of the BusinessObjectInterface interface
Member method Description Page
clone() Copies an existing business object. clone()
doVerbFor() Calls the business object handler (instance of the BOHandlerBase class) to perform the actions of the business object's active verb. doVerbFor()
dump() Formats and returns the business object information in a standard defined format for logging and tracing. dump()
getAppText() Retrieves the value of the business object's AppSpecificInfo field getAppText()
getAttrCount() Retrieves the number of attributes that the business object has. getAttrCount()
getAttrDesc() Retrieves an attribute description by name or by position. getAttrDesc()
getAttribute() Retrieves the attribute value. getAttribute()
getAttributeIndex() Retrieves the index position of a given attribute. getAttributeIndex()
getAttributeType() Retrieves the attribute type code for a given attribute using the attribute name or the attribute's position. getAttributeType()
getAttrName() Retrieves the name of an attribute by position. getAttrName()
getAttrValue() Retrieves an attribute value by name or by position. getAttrValue()
getBusinessObjectVersion() Retrieves the version of the business object. getBusinessObjectVersion()
getDefaultAttrValue() Retrieves the default value of an attribute value by name or by position. getDefaultAttrValue()
getLocale() Retrieves the locale associated with the business object. getLocale()
getName() Retrieves the name of the business object specification that the business object references. getName()
getParentBusinessObject() Retrieves the parent business object of the current business object. getParentBusinessObject()
getVerb() Retrieves the active verb for the business object. getVerb()
getVerbAppText() Retrieves the verb application-specific information. getVerbAppText()
isBlank() Determines whether the value of the attribute with the specified name or position is blank. isBlank()
isIgnore() Determines whether the value of the attribute with the specified name or position is "ignore". isIgnore()
isVerbSupported() Determines whether a verb is supported or not. isVerbSupported()
makeNewAttrObject() Creates a new object of the correct type for the attribute with the specified name or position. This operation applies typically to attributes that contain child objects. makeNewAttrObject()
setAttributeWithCreate() Sets an object's attribute value. setAttributeWithCreate()
setAttrValue() Sets the value of an attribute by name or by position. setAttrValue()
setDefaultAttrValues() Initializes the business object's attributes with their default values. setDefaultAttrValues()
setLocale() Sets the locale associated with the business object. setLocale()
setVerb() Sets the active verb for the business object. setVerb()

Copyright IBM Corp. 1997, 2003