com.ibm.commerce.component.bod

Class AbstractBusinessObjectDocument

java.lang.Object

com.ibm.commerce.component.bod.AbstractBusinessObjectDocument

All Implemented Interfaces:

BusinessObjectDocument, java.io.Serializable

Direct Known Subclasses:

AuthenticationGiftRegistryBOD, CancelGiftRegistryBOD, ConfirmBOD, PostGiftRegistryAnnouncementBOD, UpdateGiftRegistryBOD, UpdateGiftRegistryPurchaseRecordBOD

public abstract class AbstractBusinessObjectDocument
extends java.lang.Object
implements BusinessObjectDocument

The AbstractBusinessObjectDocument implements generic BusinessObjectDocument functions. Every BusinessObjectDocument has an ApplicationArea and a DataArea. This class provides methods to manipulate those containers.

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AbstractBusinessObjectDocument() Default constructor
AbstractBusinessObjectDocument(ActivityToken newToken) Constructs a Business Object Document given an activity token
AbstractBusinessObjectDocument(ActivityToken newToken, DataArea newDataArea) Creates a BusinessObjectDocument with an ActivityToken and a defined DataArea

Method Summary

Modifier and Type	Method and Description
VerbAction	getAction(BaseVO endNode, java.lang.String attr) Returns the verb action given a value object and pathname
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 property) Gets the value of the given property of a given node
void	setActivityToken(ActivityToken token) Sets the BusinessObjectDocument's activity token
void	setDataArea(DataArea area) Sets the BusinessObjectDocument's data area
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

AbstractBusinessObjectDocument

public AbstractBusinessObjectDocument()

Default constructor

AbstractBusinessObjectDocument

public AbstractBusinessObjectDocument(ActivityToken newToken)

Constructs a Business Object Document given an activity token

Parameters:

newToken -

AbstractBusinessObjectDocument

public AbstractBusinessObjectDocument(ActivityToken newToken,
                                      DataArea newDataArea)

Creates a BusinessObjectDocument with an ActivityToken and a defined DataArea

Parameters:

newToken -

newDataArea -

Method Detail

getApplicationArea

public ApplicationArea getApplicationArea()

Description copied from interface: BusinessObjectDocument

Returns the ApplicationArea inside this BusinessObjectDocument

Specified by:

getApplicationArea in interface BusinessObjectDocument

Returns:

the ApplicaitonArea inside this BusinessObjectDocument

getDataArea

public DataArea getDataArea()

Description copied from interface: BusinessObjectDocument

Returns the DataArea contained inside this BusinessObjectDocument

Specified by:

getDataArea in interface BusinessObjectDocument

Returns:

the DataArea inside this BusinessObjectDocument

getValue

public java.lang.Object getValue(java.lang.Object endNode,
                                 java.lang.String property)

Gets the value of the given property of a given node

Specified by:

getValue in interface BusinessObjectDocument

Parameters:

endNode - the object that has the given property

property - the property whose value will be returned.

Returns:

the value of endNode.get(property) or endNode.getProperty() 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

See Also:

BusinessObjectDocument.getValue(Object, String)

setDataArea

public void setDataArea(DataArea area)

Sets the BusinessObjectDocument's data area

Specified by:

setDataArea in interface BusinessObjectDocument

Parameters:

dataArea -

setActivityToken

public final void setActivityToken(ActivityToken token)

Sets the BusinessObjectDocument's activity token

Specified by:

setActivityToken in interface BusinessObjectDocument

Parameters:

token -

getAction

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

Returns the verb action given a value object and pathname

Specified by:

getAction in interface BusinessObjectDocument

Parameters:

endNode - The node that contains the given attribute. For example, if we have a calling chain A.getB().getC().getPrice(), then for the attribute price (we use JavaBean convention) has endNode A.getB().getC().

attr - the property in a JavaBean

Returns:

VerbAction The action that describes the given attribute

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

the String representation of this business object document