com.ibm.commerce.giftregistry.service.businessobjects

Class ConfirmGiftRegistryAnnouncementBOD

java.lang.Object

com.ibm.commerce.component.bod.AbstractBusinessObjectDocument

com.ibm.commerce.component.bod.ConfirmBOD

com.ibm.commerce.giftregistry.service.businessobjects.ConfirmGiftRegistryAnnouncementBOD

All Implemented Interfaces:

BusinessObjectDocument, java.io.Serializable

public class ConfirmGiftRegistryAnnouncementBOD
extends ConfirmBOD
implements BusinessObjectDocument

A ConfirmGiftRegistryAnnouncementBOD is a message that is returned to confirm the result of an announcement message being sent. A successful result implies the messages were sent successfully. A failure result means there was a problem sending the requested message.

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
ConfirmGiftRegistryAnnouncementBOD() Default Constructor
ConfirmGiftRegistryAnnouncementBOD(ActivityToken aToken, DataArea dataArea) Construct this BOD given an activity token and a data area
ConfirmGiftRegistryAnnouncementBOD(ConfirmBOD cBOD) Construct this BOD from its parent type

Method Summary

Modifier and Type	Method and Description
GiftRegistryAnnouncementVO[]	getOutcomeValueObjects() Returns all the value objects in this confirmBOD
GiftRegistryAnnouncementVO	getPrimaryNounOutcomeValue() Returns the primary noun value object that caused the failure if any.
ProcessingOutcomeMessage	getPrimaryProcessingOutcomeMessage() Returns the primary description of why a particular noun failed to be processed.

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

getConfirmation, setAppendBOD, setAppendOurcomeValueObject, setBOD, setConfirmation, setOutcomeValueObjects

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

ConfirmGiftRegistryAnnouncementBOD

public ConfirmGiftRegistryAnnouncementBOD()

Default Constructor

ConfirmGiftRegistryAnnouncementBOD

public ConfirmGiftRegistryAnnouncementBOD(ConfirmBOD cBOD)

Construct this BOD from its parent type

Parameters:

ConfirmBOD -

ConfirmGiftRegistryAnnouncementBOD

public ConfirmGiftRegistryAnnouncementBOD(ActivityToken aToken,
                                          DataArea dataArea)

Construct this BOD given an activity token and a data area

Parameters:

aToken -

dataArea -

Method Detail

getPrimaryProcessingOutcomeMessage

public ProcessingOutcomeMessage getPrimaryProcessingOutcomeMessage()

Returns the primary description of why a particular noun failed to be processed.

Returns:

ProcessingOutcomeMessage

getPrimaryNounOutcomeValue

public GiftRegistryAnnouncementVO getPrimaryNounOutcomeValue()

Returns the primary noun value object that caused the failure if any.

Returns:

GiftRegistryAuthenticationVO

getOutcomeValueObjects

public GiftRegistryAnnouncementVO[] getOutcomeValueObjects()

Returns all the value objects in this confirmBOD

Returns:

GiftRegistryAnnouncementVO[]