GiftListType

```
public interface GiftListType
```
A representation of the model object 'Gift List Type'. The GiftList noun type, which applies to both a wish list and a gift registry.
The following features are supported:
See Also:

GiftCenterPackage.getGiftListType()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`GiftListAccessSpecifierType`	`getAccessSpecifier()` Returns the value of the 'Access Specifier' containment reference.
`java.util.List`	`getAnnouncement()` Returns the value of the 'Announcement' containment reference list.
`java.util.List`	`getCoRegistrant()` Returns the value of the 'Co Registrant' containment reference list.
`java.lang.Object`	`getCreatedTime()` Returns the value of the 'Created Time' attribute.
`GiftListDescriptionType`	`getDescription()` Returns the value of the 'Description' containment reference.
`GiftListEventInformationType`	`getEventInformation()` Returns the value of the 'Event Information' containment reference.
`com.ibm.commerce.foundation.common.datatypes.GiftListIdentifierType`	`getGiftListIdentifier()` Returns the value of the 'Gift List Identifier' containment reference.
`java.util.List`	`getItem()` Returns the value of the 'Item' containment reference list.
`java.lang.Object`	`getLastUpdate()` Returns the value of the 'Last Update' attribute.
`java.lang.String`	`getLocation()` Returns the value of the 'Location' attribute.
`java.util.List`	`getPurchaseRecord()` Returns the value of the 'Purchase Record' containment reference list.
`GiftListRegistrantType`	`getRegistrant()` Returns the value of the 'Registrant' containment reference.
`java.lang.String`	`getState()` Returns the value of the 'State' attribute.
`UserDataType`	`getUserData()` Returns the value of the 'User Data' containment reference.
`boolean`	`isOptForEmail()` Returns the value of the 'Opt For Email' attribute.
`boolean`	`isRegistry()` Returns the value of the 'Registry' attribute.
`boolean`	`isSetOptForEmail()` Returns whether the value of the '`Opt For Email`' attribute is set.
`boolean`	`isSetRegistry()` Returns whether the value of the '`Registry`' attribute is set.
`void`	`setAccessSpecifier(GiftListAccessSpecifierType value)` Sets the value of the '`Access Specifier`' containment reference.
`void`	`setCreatedTime(java.lang.Object value)` Sets the value of the '`Created Time`' attribute.
`void`	`setDescription(GiftListDescriptionType value)` Sets the value of the '`Description`' containment reference.
`void`	`setEventInformation(GiftListEventInformationType value)` Sets the value of the '`Event Information`' containment reference.
`void`	`setGiftListIdentifier(com.ibm.commerce.foundation.common.datatypes.GiftListIdentifierType value)` Sets the value of the '`Gift List Identifier`' containment reference.
`void`	`setLastUpdate(java.lang.Object value)` Sets the value of the '`Last Update`' attribute.
`void`	`setLocation(java.lang.String value)` Sets the value of the '`Location`' attribute.
`void`	`setOptForEmail(boolean value)` Sets the value of the '`Opt For Email`' attribute.
`void`	`setRegistrant(GiftListRegistrantType value)` Sets the value of the '`Registrant`' containment reference.
`void`	`setRegistry(boolean value)` Sets the value of the '`Registry`' attribute.
`void`	`setState(java.lang.String value)` Sets the value of the '`State`' attribute.
`void`	`setUserData(UserDataType value)` Sets the value of the '`User Data`' containment reference.
`void`	`unsetOptForEmail()` Unsets the value of the '`Opt For Email`' attribute.
`void`	`unsetRegistry()` Unsets the value of the '`Registry`' attribute.

- Method Detail
  - getGiftListIdentifier
```
com.ibm.commerce.foundation.common.datatypes.GiftListIdentifierType getGiftListIdentifier()
```
    Returns the value of the 'Gift List Identifier' containment reference. The gift list identifier.
    
    Returns:
    
    the value of the 'Gift List Identifier' containment reference.
    
    See Also:
    
    setGiftListIdentifier(GiftListIdentifierType), GiftCenterPackage.getGiftListType_GiftListIdentifier()
  - setGiftListIdentifier
```
void setGiftListIdentifier(com.ibm.commerce.foundation.common.datatypes.GiftListIdentifierType value)
```
    Sets the value of the 'Gift List Identifier' containment reference.
    
    Parameters:
    
    value - the new value of the 'Gift List Identifier' containment reference.
    
    See Also:
    
    getGiftListIdentifier()
  - getDescription
```
GiftListDescriptionType getDescription()
```
    Returns the value of the 'Description' containment reference. Description of the gift list.
    
    Returns:
    
    the value of the 'Description' containment reference.
    
    See Also:
    
    setDescription(GiftListDescriptionType), GiftCenterPackage.getGiftListType_Description()
  - setDescription
```
void setDescription(GiftListDescriptionType value)
```
    Sets the value of the 'Description' containment reference.
    
    Parameters:
    
    value - the new value of the 'Description' containment reference.
    
    See Also:
    
    getDescription()
  - getEventInformation
```
GiftListEventInformationType getEventInformation()
```
    Returns the value of the 'Event Information' containment reference. Information about the event for which the list is created.
    
    Returns:
    
    the value of the 'Event Information' containment reference.
    
    See Also:
    
    setEventInformation(GiftListEventInformationType), GiftCenterPackage.getGiftListType_EventInformation()
  - setEventInformation
```
void setEventInformation(GiftListEventInformationType value)
```
    Sets the value of the 'Event Information' containment reference.
    
    Parameters:
    
    value - the new value of the 'Event Information' containment reference.
    
    See Also:
    
    getEventInformation()
  - getRegistrant
```
GiftListRegistrantType getRegistrant()
```
    Returns the value of the 'Registrant' containment reference. The primary registrant or creator of the gift list.
    
    Returns:
    
    the value of the 'Registrant' containment reference.
    
    See Also:
    
    setRegistrant(GiftListRegistrantType), GiftCenterPackage.getGiftListType_Registrant()
  - setRegistrant
```
void setRegistrant(GiftListRegistrantType value)
```
    Sets the value of the 'Registrant' containment reference.
    
    Parameters:
    
    value - the new value of the 'Registrant' containment reference.
    
    See Also:
    
    getRegistrant()
  - getCoRegistrant
```
java.util.List getCoRegistrant()
```
    Returns the value of the 'Co Registrant' containment reference list. The list contents are of type GiftListRegistrantType. Registrants who co-own the list.
    
    Returns:
    
    the value of the 'Co Registrant' containment reference list.
    
    See Also:
    
    GiftCenterPackage.getGiftListType_CoRegistrant()
  - getAccessSpecifier
```
GiftListAccessSpecifierType getAccessSpecifier()
```
    Returns the value of the 'Access Specifier' containment reference. The access restrictions that are to be imposed on the gift list.
    
    Returns:
    
    the value of the 'Access Specifier' containment reference.
    
    See Also:
    
    setAccessSpecifier(GiftListAccessSpecifierType), GiftCenterPackage.getGiftListType_AccessSpecifier()
  - setAccessSpecifier
```
void setAccessSpecifier(GiftListAccessSpecifierType value)
```
    Sets the value of the 'Access Specifier' containment reference.
    
    Parameters:
    
    value - the new value of the 'Access Specifier' containment reference.
    
    See Also:
    
    getAccessSpecifier()
  - getItem
```
java.util.List getItem()
```
    Returns the value of the 'Item' containment reference list. The list contents are of type GiftListItemType. The items that registrants and co-registrants are requesting.
    
    Returns:
    
    the value of the 'Item' containment reference list.
    
    See Also:
    
    GiftCenterPackage.getGiftListType_Item()
  - getAnnouncement
```
java.util.List getAnnouncement()
```
    Returns the value of the 'Announcement' containment reference list. The list contents are of type GiftListAnnouncementType. The e-mail announcements made about the gift list by the registrants to friends and family.
    
    Returns:
    
    the value of the 'Announcement' containment reference list.
    
    See Also:
    
    GiftCenterPackage.getGiftListType_Announcement()
  - isRegistry
```
boolean isRegistry()
```
    Returns the value of the 'Registry' attribute. Indicates whether the noun is being used for GiftRegistry or WishList.
    
    Returns:
    
    the value of the 'Registry' attribute.
    
    See Also:
    
    isSetRegistry(), unsetRegistry(), setRegistry(boolean), GiftCenterPackage.getGiftListType_Registry()
  - setRegistry
```
void setRegistry(boolean value)
```
    Sets the value of the 'Registry' attribute.
    
    Parameters:
    
    value - the new value of the 'Registry' attribute.
    
    See Also:
    
    isSetRegistry(), unsetRegistry(), isRegistry()
  - unsetRegistry
```
void unsetRegistry()
```
    Unsets the value of the 'Registry' attribute.
    
    See Also:
    
    isSetRegistry(), isRegistry(), setRegistry(boolean)
  - isSetRegistry
```
boolean isSetRegistry()
```
    Returns whether the value of the 'Registry' attribute is set.
    
    Returns:
    
    whether the value of the 'Registry' attribute is set.
    
    See Also:
    
    unsetRegistry(), isRegistry(), setRegistry(boolean)
  - isOptForEmail
```
boolean isOptForEmail()
```
    Returns the value of the 'Opt For Email' attribute. Indicates whether the registrant wants to receive e-mails about the gift list.
    
    Returns:
    
    the value of the 'Opt For Email' attribute.
    
    See Also:
    
    isSetOptForEmail(), unsetOptForEmail(), setOptForEmail(boolean), GiftCenterPackage.getGiftListType_OptForEmail()
  - setOptForEmail
```
void setOptForEmail(boolean value)
```
    Sets the value of the 'Opt For Email' attribute.
    
    Parameters:
    
    value - the new value of the 'Opt For Email' attribute.
    
    See Also:
    
    isSetOptForEmail(), unsetOptForEmail(), isOptForEmail()
  - unsetOptForEmail
```
void unsetOptForEmail()
```
    Unsets the value of the 'Opt For Email' attribute.
    
    See Also:
    
    isSetOptForEmail(), isOptForEmail(), setOptForEmail(boolean)
  - isSetOptForEmail
```
boolean isSetOptForEmail()
```
    Returns whether the value of the 'Opt For Email' attribute is set.
    
    Returns:
    
    whether the value of the 'Opt For Email' attribute is set.
    
    See Also:
    
    unsetOptForEmail(), isOptForEmail(), setOptForEmail(boolean)
  - getState
```
java.lang.String getState()
```
    Returns the value of the 'State' attribute. The status of the gift list. Valid statuses are: Active, Default, Deleted, Complete, Expired.
    
    Returns:
    
    the value of the 'State' attribute.
    
    See Also:
    
    setState(String), GiftCenterPackage.getGiftListType_State()
  - setState
```
void setState(java.lang.String value)
```
    Sets the value of the 'State' attribute.
    
    Parameters:
    
    value - the new value of the 'State' attribute.
    
    See Also:
    
    getState()
  - getLocation
```
java.lang.String getLocation()
```
    Returns the value of the 'Location' attribute. The location or channel from where the gift list was created.
    
    Returns:
    
    the value of the 'Location' attribute.
    
    See Also:
    
    setLocation(String), GiftCenterPackage.getGiftListType_Location()
  - setLocation
```
void setLocation(java.lang.String value)
```
    Sets the value of the 'Location' attribute.
    
    Parameters:
    
    value - the new value of the 'Location' attribute.
    
    See Also:
    
    getLocation()
  - getCreatedTime
```
java.lang.Object getCreatedTime()
```
    Returns the value of the 'Created Time' attribute. The date and time when the gift list is created.
    
    Returns:
    
    the value of the 'Created Time' attribute.
    
    See Also:
    
    setCreatedTime(Object), GiftCenterPackage.getGiftListType_CreatedTime()
  - setCreatedTime
```
void setCreatedTime(java.lang.Object value)
```
    Sets the value of the 'Created Time' attribute.
    
    Parameters:
    
    value - the new value of the 'Created Time' attribute.
    
    See Also:
    
    getCreatedTime()
  - getLastUpdate
```
java.lang.Object getLastUpdate()
```
    Returns the value of the 'Last Update' attribute. The date and time when the gift list was last updated.
    
    Returns:
    
    the value of the 'Last Update' attribute.
    
    See Also:
    
    setLastUpdate(Object), GiftCenterPackage.getGiftListType_LastUpdate()
  - setLastUpdate
```
void setLastUpdate(java.lang.Object value)
```
    Sets the value of the 'Last Update' attribute.
    
    Parameters:
    
    value - the new value of the 'Last Update' attribute.
    
    See Also:
    
    getLastUpdate()
  - getPurchaseRecord
```
java.util.List getPurchaseRecord()
```
    Returns the value of the 'Purchase Record' containment reference list. The list contents are of type GiftListPurchaseRecordType. The element definition of the purchase record.
    
    Returns:
    
    the value of the 'Purchase Record' containment reference list.
    
    See Also:
    
    GiftCenterPackage.getGiftListType_PurchaseRecord()
  - getUserData
```
UserDataType getUserData()
```
    Returns the value of the 'User Data' containment reference.
    If the meaning of the 'User Data' containment reference isn't clear, there really should be more of a description here...
    
    Returns:
    
    the value of the 'User Data' containment reference.
    
    See Also:
    
    setUserData(UserDataType), GiftCenterPackage.getGiftListType_UserData()
  - setUserData
```
void setUserData(UserDataType value)
```
    Sets the value of the 'User Data' containment reference.
    
    Parameters:
    
    value - the new value of the 'User Data' containment reference.
    
    See Also:
    
    getUserData()

getGiftListIdentifier

setGiftListIdentifier

getDescription

setDescription

getEventInformation

setEventInformation

getRegistrant

setRegistrant

getCoRegistrant

getAccessSpecifier

setAccessSpecifier

getItem

getAnnouncement

isRegistry

setRegistry

unsetRegistry

isSetRegistry

isOptForEmail

setOptForEmail

unsetOptForEmail

isSetOptForEmail

getState

setState

getLocation

setLocation

getCreatedTime

setCreatedTime

getLastUpdate

setLastUpdate

getPurchaseRecord

getUserData

setUserData