com.ibm.commerce.component.bod

Class ConfirmBOD

java.lang.Object

com.ibm.commerce.component.bod.AbstractBusinessObjectDocument

com.ibm.commerce.component.bod.ConfirmBOD

All Implemented Interfaces:

BusinessObjectDocument, java.io.Serializable

Direct Known Subclasses:

ConfirmAuthenticationGiftRegistryBOD, ConfirmGiftRegistryAnnouncementBOD, ConfirmGiftRegistryBOD, ConfirmGiftRegistryPurchaseRecordBOD

public class ConfirmBOD
extends AbstractBusinessObjectDocument
implements BusinessObjectDocument

A generic confirm BOD to be inherited by more specific confirm BODs. A ConfirmBOD is a BusinessObjectDocument. This BusinessObjectDocument definition contains an ApplicationArea and a DataArea like all others. However the DataArea contains a noun com.ibm.commerce.giftregistry.service.valueobjects.BOD. The BOD noun contains some or all of the requested nouns and a ProcessingOutcomeMessage.

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
ConfirmBOD() Default constructor
ConfirmBOD(ActivityToken aToken, DataArea dataArea) Construct the object by specifying a token and dataArea
ConfirmBOD(ConfirmBOD cBOD) Constructor to create this ConfirmBOD from another.

Method Summary

Modifier and Type	Method and Description
Confirmation	getConfirmation() Get the success or failure status of the original request.
void	setAppendBOD(BOD bod) Sets the BOD object that holds the NounOutcomeValue and ProcessingOutcomeMessage
void	setAppendOurcomeValueObject(BaseVO baseVO) Creates a BOD object and inserts the given value object inside of it.
void	setBOD(BOD[] bods) Sets the BOD object that holds the NounOutcomeValue and ProcessingOutcomeMessage
void	setConfirmation(Confirmation pConfirmation) Sets the success or failure status of the original request.
void	setOutcomeValueObjects(java.util.List baseVOList) Given a list of valueObjects, a BOD is created for each which consists of one value object each.

Methods inherited from class com.ibm.commerce.component.bod.AbstractBusinessObjectDocument

getAction, getApplicationArea, getDataArea, getValue, setActivityToken, setDataArea, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.commerce.component.bod.BusinessObjectDocument

getAction, getApplicationArea, getDataArea, getValue, setActivityToken, setDataArea

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

ConfirmBOD

public ConfirmBOD()

Default constructor

ConfirmBOD

public ConfirmBOD(ConfirmBOD cBOD)

Constructor to create this ConfirmBOD from another.

Parameters:

the - confirmation BOD whose content will be copied to the create BOD.

ConfirmBOD

public ConfirmBOD(ActivityToken aToken,
                  DataArea dataArea)

Construct the object by specifying a token and dataArea

Parameters:

aToken - the activity token used by this BOD.

dataArea - the data area that will be used by this BOD

Method Detail

getConfirmation

public Confirmation getConfirmation()

Get the success or failure status of the original request.

Returns:

Confirmation the confirmation contained in this BOD

setConfirmation

public void setConfirmation(Confirmation pConfirmation)

Sets the success or failure status of the original request.

Parameters:

confirmation - the confirmation used by this BOD

setBOD

public void setBOD(BOD[] bods)

Sets the BOD object that holds the NounOutcomeValue and ProcessingOutcomeMessage

Parameters:

a - list of BOD instances contained in this object.

setAppendBOD

public void setAppendBOD(BOD bod)

Sets the BOD object that holds the NounOutcomeValue and ProcessingOutcomeMessage

Parameters:

BOD - the object to be appened.

setAppendOurcomeValueObject

public void setAppendOurcomeValueObject(BaseVO baseVO)

Creates a BOD object and inserts the given value object inside of it. The BOD object is then appended to this ConfirmBOD's data area.

Parameters:

BaseVO - the value object that will be used to construct the BOD, which will then be appended.

setOutcomeValueObjects

public void setOutcomeValueObjects(java.util.List baseVOList)

Given a list of valueObjects, a BOD is created for each which consists of one value object each. The BOD's are appended to this ConfirmBOD as nouns

Parameters:

the - list of value objects that will be converted into outcome value, which will be appended.