CancelGiftRegistryBOD

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.giftregistry.service.businessobjects.CancelGiftRegistryBOD

All Implemented Interfaces:

BusinessObjectDocument, java.io.Serializable
```
public class CancelGiftRegistryBOD
extends AbstractBusinessObjectDocument
implements BusinessObjectDocument
```
A BusinessObjectDocument for canceling a gift registry. This BOD carries service request that cancels the gift registries described by this BOD's nouns. It should contain only GiftRegistryVO as its nouns.

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
`CancelGiftRegistryBOD()` Default constructor
`CancelGiftRegistryBOD(ActivityToken aToken, DataArea dataArea)` Constructs the object by specifying a token and `DataArea`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GiftRegistryVO[]`	`getGiftRegistries()` Gets all the gift registries stored in the data area
`void`	`setGiftRegistries(GiftRegistryVO[] giftRegistries)` Sets gift registries in the data area of this bod

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
  - CancelGiftRegistryBOD
```
public CancelGiftRegistryBOD()
```
    Default constructor
  - CancelGiftRegistryBOD
```
public CancelGiftRegistryBOD(ActivityToken aToken,
                             DataArea dataArea)
```
    Constructs the object by specifying a token and DataArea
    
    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
  - getGiftRegistries
```
public GiftRegistryVO[] getGiftRegistries()
```
    Gets all the gift registries stored in the data area
    
    Returns:
    
    GiftRegistryVO[] an array of GiftRegistryVO objects
  - setGiftRegistries
```
public void setGiftRegistries(GiftRegistryVO[] giftRegistries)
```
    Sets gift registries in the data area of this bod
    
    Parameters:
    
    GiftRegistryVO[] - the nouns that this BOD will have