com.ibm.commerce.component.bod

Interface BusinessObjectDocument

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbstractBusinessObjectDocument, AuthenticationGiftRegistryBOD, CancelGiftRegistryBOD, ConfirmAuthenticationGiftRegistryBOD, ConfirmBOD, ConfirmGiftRegistryAnnouncementBOD, ConfirmGiftRegistryBOD, ConfirmGiftRegistryPurchaseRecordBOD, PostGiftRegistryAnnouncementBOD, UpdateGiftRegistryBOD, UpdateGiftRegistryPurchaseRecordBOD

public interface BusinessObjectDocument
extends java.io.Serializable

Definition of the structure of a message. This is the input and output parameter of all BusinessObjectDocument Commands. It packages an ApplicationArea and a DataArea. The DataArea in turn contains a Verb (actions) and one or more Nouns (raw data).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Method Summary

Modifier and Type	Method and Description
VerbAction	getAction(BaseVO endNode, java.lang.String attr) Gets the action that's corresponding to the given endNode and its attribute
ApplicationArea	getApplicationArea() Returns the ApplicationArea inside this BusinessObjectDocument
DataArea	getDataArea() Returns the DataArea contained inside this BusinessObjectDocument
java.lang.Object	getValue(java.lang.Object endNode, java.lang.String attribute) Gets the value of the given attribute of a given node
void	setActivityToken(ActivityToken token) Sets the activity token of for this object
void	setDataArea(DataArea area) Sets the DataArea of a business object document.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Method Detail

getApplicationArea

ApplicationArea getApplicationArea()

Returns the ApplicationArea inside this BusinessObjectDocument

Returns:

ApplicationArea

getDataArea

DataArea getDataArea()

Returns the DataArea contained inside this BusinessObjectDocument

Returns:

DataArea

setActivityToken

void setActivityToken(ActivityToken token)

Sets the activity token of for this object

Parameters:

token - the token to be set

setDataArea

void setDataArea(DataArea area)

Sets the DataArea of a business object document. The existing data area will be overwritten.

Parameters:

area - The DataArea of a BOD

getAction

VerbAction getAction(BaseVO endNode,
                     java.lang.String attr)

Gets the action that's corresponding to the given endNode and its attribute

Parameters:

endNode -

attribute -

Returns:

the action of the path that leads to endNode.getAttr(). Null if there is no action found

getValue

java.lang.Object getValue(java.lang.Object endNode,
                          java.lang.String attribute)

Gets the value of the given attribute of a given node

Parameters:

endNode -

attribute -

Returns:

the value of endNode.get(attribute) or endNode.getAttribute() if the value is not null. Otherwise, if there is a path that ends with endNode.getAttribute(), the value found with the path will be returned. If none of the two above are satisfied, NullObject.VALUE will be returned