ConfirmGiftRegistryBOD

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.ibm.commerce.component.bod.AbstractBusinessObjectDocument
- - com.ibm.commerce.component.bod.ConfirmBOD
  - - com.ibm.commerce.giftregistry.service.businessobjects.ConfirmGiftRegistryBOD

All Implemented Interfaces:

BusinessObjectDocument, java.io.Serializable
```
public class ConfirmGiftRegistryBOD
extends ConfirmBOD
implements BusinessObjectDocument
```
A ConfirmGiftRegistryBOD is a message that is returned to confirm the result of a gift registry update being requested. A successful result implies the update was processed successfully. A failure result means there was a problem processing the update.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GiftRegistryVO[]`	`getOutcomeValueObjects()` Returns all the value objects in this `confirmBOD`
`GiftRegistryVO`	`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
  - ConfirmGiftRegistryBOD
```
public ConfirmGiftRegistryBOD()
```
    Default Constructor
  - ConfirmGiftRegistryBOD
```
public ConfirmGiftRegistryBOD(ConfirmBOD cBOD)
```
    Construct this BOD from its parent type
    
    Parameters:
    
    ConfirmBOD -
  - ConfirmGiftRegistryBOD
```
public ConfirmGiftRegistryBOD(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 GiftRegistryVO getPrimaryNounOutcomeValue()
```
    Returns the primary noun value object that caused the failure if any.
    
    Returns:
    
    GiftRegistryVO
  - getOutcomeValueObjects
```
public GiftRegistryVO[] getOutcomeValueObjects()
```
    Returns all the value objects in this confirmBOD
    
    Returns:
    
    GiftRegistryVO[]