com.ibm.commerce.giftregistry.service.businessobjects

Class ConfirmAuthenticationGiftRegistryBOD

java.lang.Object

com.ibm.commerce.component.bod.AbstractBusinessObjectDocument

com.ibm.commerce.component.bod.ConfirmBOD

com.ibm.commerce.giftregistry.service.businessobjects.ConfirmAuthenticationGiftRegistryBOD

All Implemented Interfaces:

BusinessObjectDocument, java.io.Serializable

public class ConfirmAuthenticationGiftRegistryBOD
extends ConfirmBOD
implements BusinessObjectDocument

A ConfirmAuthenticationGiftRegistryBOD is a message that is returned to confirm the result of an authentication request to a gift registry. A successful result means authentication was a success. Failure means it was not successful.

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

Method Summary

Modifier and Type	Method and Description
GiftRegistryAuthenticationVO[]	getOutcomeValueObjects() Returns all the value objects in this confirmBOD
GiftRegistryAuthenticationVO	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

ConfirmAuthenticationGiftRegistryBOD

public ConfirmAuthenticationGiftRegistryBOD()

Default Constructor

ConfirmAuthenticationGiftRegistryBOD

public ConfirmAuthenticationGiftRegistryBOD(ConfirmBOD cBOD)

Construct this BOD from its parent type

Parameters:

ConfirmBOD - the generic confirmmation BOD that this object is based on

ConfirmAuthenticationGiftRegistryBOD

public ConfirmAuthenticationGiftRegistryBOD(ActivityToken aToken,
                                            DataArea dataArea)

Construct this BOD given an activity token and a data area

Parameters:

aToken - an activity token that uniquely identifies the activity to which this service BOD belongs

dataArea - A DataArea instance that contains verb and nouns

Method Detail

getPrimaryProcessingOutcomeMessage

public ProcessingOutcomeMessage getPrimaryProcessingOutcomeMessage()

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

Returns:

ProcessingOutcomeMessage

getPrimaryNounOutcomeValue

public GiftRegistryAuthenticationVO getPrimaryNounOutcomeValue()

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

Returns:

GiftRegistryAuthenticationVO the value object that caused the failure

getOutcomeValueObjects

public GiftRegistryAuthenticationVO[] getOutcomeValueObjects()

Returns all the value objects in this confirmBOD

Returns:

GiftRegistryAuthenticationVO[] An array of updated authentication value objects after successful authentication