com.ibm.commerce.giftregistry.service.valueobjects

Class GiftRegistryVO

  • All Implemented Interfaces:
    java.io.Serializable


    public class GiftRegistryVO
    extends BaseVO
    Contains object data corresponding to a gift registry object.
    See Also:
    Serialized Form
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
      • CLASS_NAME

        public static final java.lang.String CLASS_NAME
        Name of this class
      • GIFT_REGISTRY_TYPE

        public static final java.lang.String GIFT_REGISTRY_TYPE
        Registry type
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_COREGISTRANT_PASSWORD

        public static final java.lang.String GIFT_REGISTRY_COREGISTRANT_PASSWORD
        Co-registrant password
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_REGISTRANT_ACCESS_KEY

        public static final java.lang.String GIFT_REGISTRY_REGISTRANT_ACCESS_KEY
        Registrant access key
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_PRE_EVENT_SHIPPING_ADDRESS

        public static final java.lang.String GIFT_REGISTRY_PRE_EVENT_SHIPPING_ADDRESS
        Pre-event shipping address
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_POST_EVENT_SHIPPING_ADDRESS

        public static final java.lang.String GIFT_REGISTRY_POST_EVENT_SHIPPING_ADDRESS
        Post-event shipping address
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_GUEST_ACCESS_KEY

        public static final java.lang.String GIFT_REGISTRY_GUEST_ACCESS_KEY
        Guest access key
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_FIELD1

        public static final java.lang.String GIFT_REGISTRY_FIELD1
        Gift registry customizable field 1
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_FIELD2

        public static final java.lang.String GIFT_REGISTRY_FIELD2
        Gift registry customizable field 2
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_FIELD3

        public static final java.lang.String GIFT_REGISTRY_FIELD3
        Gift registry customizable field 3
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_FIELD4

        public static final java.lang.String GIFT_REGISTRY_FIELD4
        Gift registry customizable field 4
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_FIELD5

        public static final java.lang.String GIFT_REGISTRY_FIELD5
        Gift registry customizable field 5
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_STATUS

        public static final java.lang.String GIFT_REGISTRY_STATUS
        Gift registry status
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_STORE_ID

        public static final java.lang.String GIFT_REGISTRY_STORE_ID
        Store ID
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_MESSAGE_FOR_GUEST

        public static final java.lang.String GIFT_REGISTRY_MESSAGE_FOR_GUEST
        Message for guest
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_OPT_FOR_EMAIL

        public static final java.lang.String GIFT_REGISTRY_OPT_FOR_EMAIL
        Option for email
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_EVENT_DATE

        public static final java.lang.String GIFT_REGISTRY_EVENT_DATE
        Gift registry event date
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_CREATED_TIME

        public static final java.lang.String GIFT_REGISTRY_CREATED_TIME
        Gift registry creation time
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_EVENT_TYPE_ID

        public static final java.lang.String GIFT_REGISTRY_EVENT_TYPE_ID
        Gift registry event type ID
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_ACCEPT_GIFT_CARD

        public static final java.lang.String GIFT_REGISTRY_ACCEPT_GIFT_CARD
        Flag for accept gift card
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_GUEST_OPTION

        public static final java.lang.String GIFT_REGISTRY_GUEST_OPTION
        Option for guest user browsing of the gift registry
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_NAME

        public static final java.lang.String GIFT_REGISTRY_NAME
        Name of the gift registry
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_EXTERNAL_ID

        public static final java.lang.String GIFT_REGISTRY_EXTERNAL_ID
        Gift registry external ID
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_DESCRIPTION

        public static final java.lang.String GIFT_REGISTRY_DESCRIPTION
        Gift registry description
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_REGISTRANTS

        public static final java.lang.String GIFT_REGISTRY_REGISTRANTS
        Registrants
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_REGISTRANTS_ARRAY

        public static final java.lang.String GIFT_REGISTRY_REGISTRANTS_ARRAY
        RegistrantsArray. The array representation of the registrant list
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_GIFT_ITEMS_ARRAY

        public static final java.lang.String GIFT_REGISTRY_GIFT_ITEMS_ARRAY
        RegistrantsArray. The array representation of the registrant list
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_GIFT_ITEMS

        public static final java.lang.String GIFT_REGISTRY_GIFT_ITEMS
        Gift Items
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_REGISTRANT_PASSWORD

        public static final java.lang.String GIFT_REGISTRY_REGISTRANT_PASSWORD
        Registrant password of the gift registry
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_GUEST_PASSWORD

        public static final java.lang.String GIFT_REGISTRY_GUEST_PASSWORD
        Gift giver password of the gift registry
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_LOCATION

        public static final java.lang.String GIFT_REGISTRY_LOCATION
        Gift registry location
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_GIFTREGISTRY_ID

        public static final java.lang.String GIFT_REGISTRY_GIFTREGISTRY_ID
        Gift registry ID
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_UPDATED_TIME

        public static final java.lang.String GIFT_REGISTRY_UPDATED_TIME
        Last update time of the gift registry
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_PRE_EVENT_SHIPPING_PREFERENCE

        public static final java.lang.String GIFT_REGISTRY_PRE_EVENT_SHIPPING_PREFERENCE
        Pre-event shipping preference
        See Also:
        Constant Field Values
      • GIFT_REGISTRY_POST_EVENT_SHIPPING_PREFERENCE

        public static final java.lang.String GIFT_REGISTRY_POST_EVENT_SHIPPING_PREFERENCE
        Post-event shipping preference
        See Also:
        Constant Field Values
    • Constructor Detail

      • GiftRegistryVO

        public GiftRegistryVO()
        Default constructor
      • GiftRegistryVO

        public GiftRegistryVO(GiftRegistryVO vo)
        Create a gift registry value object
        Parameters:
        vo -
    • Method Detail

      • setRegistrantsArray

        public void setRegistrantsArray(int index,
                                        GiftRegistryRegistrantVO registrant)
        Sets a registrant
        Parameters:
        index - the index of the registrant in the registrant list
        registrant - the registrant to set
      • setRegistrantsArray

        public void setRegistrantsArray(GiftRegistryRegistrantVO[] registrants)
        Sets the whole registrant list
        Parameters:
        registrants - the list of registrants
      • setRegistrants

        public void setRegistrants(int index,
                                   GiftRegistryRegistrantVO registrant)
        Set the registrant to registrant list
        Parameters:
        index - the index in the registrant list
        registrant - the registrant to set
      • getRegistrants

        public GiftRegistryRegistrantVO getRegistrants(int index)
        Retrieves the registrant at the given index in the registrant list.
        Parameters:
        index - the index where the registrant is
        Returns:
        the registrant that is at the given index in the registrant list. If the index is out of the range of the registrant, this method will return Null .
      • getRegistrantsArray

        public GiftRegistryRegistrantVO getRegistrantsArray(int index)
        Gets the registrant in the give position of the registrant list
        Parameters:
        index - the index of the registrant
        Returns:
        the registrant at the given index
      • getAcceptGiftCard

        public java.lang.Integer getAcceptGiftCard()
        Returns:
        GIFT_REGISTRY_ACCEPT_GIFT_CARD
      • setAcceptGiftCard

        public void setAcceptGiftCard(java.lang.Integer choice)
        Sets the value of the accept gift card option to specify accept gift card or not
        Parameters:
        choice -
      • setAcceptGiftCard

        public void setAcceptGiftCard(boolean choice)
        Sets the value of the accept gift card option to specify accept gift card or not
        Parameters:
        choice -
      • getGuestOption

        public java.lang.Integer getGuestOption()
        Gets the value of guest option
        Returns:
        option
      • setGuestOption

        public void setGuestOption(java.lang.Integer option)
        Set the value of guest option
        Parameters:
        option -
      • setGuestOption

        public void setGuestOption(int option)
        Set the value of guest option
        Parameters:
        option -
      • getName

        public java.lang.String getName()
        Gets the registry name
        Returns:
        name
      • setName

        public void setName(java.lang.String name)
        set the registry name
        Parameters:
        name -
      • getGiftRegistryId

        public java.lang.Long getGiftRegistryId()
        Gets the gift registry ID
        Returns:
        giftRegistryId
      • setGiftRegistryId

        public void setGiftRegistryId(java.lang.Long grId)
        Set the gift registry ID
        Parameters:
        giftRegistryId -
      • getExternalId

        public java.lang.String getExternalId()
        Gets the external ID of the gift registry
        Returns:
        externalId
        See Also:
        setExternalId(String)
      • setExternalId

        public void setExternalId(java.lang.String id)
        Sets the external ID of the gift registry. An external ID is a unique ID that is used to identify a gift registry. It can be any non-empty string.
        Parameters:
        externalId -
      • getGiftItems

        public java.util.List getGiftItems()
        Gets the list gift items from the gift registry.
        Returns:
        giftItems the list of items in this gift registry. An empty list if there is no item in the gift registry.
      • setGiftItems

        public void setGiftItems(java.util.List items)
        Sets the gift items to the gift registry
        Parameters:
        giftItems - the items to set
      • setGiftItems

        public void setGiftItems(int index,
                                 GiftRegistryItemVO item)
        Sets an item to the indicated position in the gift item list.
        Parameters:
        index - the position where the item will be set
        item - the item that will be set
      • getGiftItems

        public GiftRegistryItemVO getGiftItems(int index)
        Retrieves an item from the item list at the given postion
        Parameters:
        index - the position of the item that is to be retrieved
        Returns:
        the item at the given position. If the index is out of the item range, a null will be returned
      • getGiftItemsArray

        public GiftRegistryItemVO[] getGiftItemsArray()
        Returns:
        an array of gift items
      • setGiftItemsArray

        public void setGiftItemsArray(int index,
                                      GiftRegistryItemVO item)
        Sets an item
        Parameters:
        index - the index of the gift item in the item list
        item - the item to set
      • setGiftItemsArray

        public void setGiftItemsArray(GiftRegistryItemVO[] items)
        Sets the whole item list
        Parameters:
        items - the list of items
      • getGiftItemsArray

        public GiftRegistryItemVO getGiftItemsArray(int index)
        Parameters:
        index - the position of the item in the item list
        Returns:
        the item that in the given position of the item list
      • getRegistrants

        public java.util.List getRegistrants()
        Gets the list of registrant from the gift registry
        Returns:
        registrants
      • setRegistrants

        public void setRegistrants(java.util.List registrants)
        Sets the list of registrant to the gift registry
        Parameters:
        registrants -
      • getDescription

        public java.lang.String getDescription()
        Gets the gift registry description
        Returns:
        description
      • setDescription

        public void setDescription(java.lang.String description)
        Sets the gift registry description
        Parameters:
        description -
      • setEventTypeId

        public void setEventTypeId(java.lang.Integer anEventTypeId)
        Set the event type ID for the gift registry
        Parameters:
        eventTypeId -
      • getEventTypeId

        public java.lang.Integer getEventTypeId()
        Get the event type ID of the gift registry
        Returns:
        eventTypeId
      • getCreatedTime

        public java.sql.Timestamp getCreatedTime()
        Gets the creation time of the gift registry
        Returns:
        createdTime
      • setCreatedTime

        public void setCreatedTime(java.sql.Timestamp time)
        Set the creation time for the gift registry
        Parameters:
        time -
      • getEventDate

        public java.sql.Date getEventDate()
        Gets the event date of the gift registry
        Returns:
        eventDate
      • setEventDate

        public void setEventDate(java.sql.Date eventDate)
        Sets the event date for the gift registry
        Parameters:
        eventDate -
      • setOptForEmail

        public void setOptForEmail(java.lang.Integer option)
        set the option for accept email about the gift registry
        Parameters:
        option -
      • getOptForEmail

        public java.lang.Integer getOptForEmail()
        Gets the value of option for accept email about the gift registry
        Returns:
        option
      • setMessageForGuest

        public void setMessageForGuest(java.lang.String message)
        Sets the message for guess for the gift registry
        Parameters:
        message -
      • getMessageForGuest

        public java.lang.String getMessageForGuest()
        Gets the message for guess of the gift registry
        Returns:
      • setLocation

        public void setLocation(java.lang.String location)
        sets the purchase location of the gift registry
        Parameters:
        location -
      • getLocation

        public java.lang.String getLocation()
        Gets the purchase location of the gift registry
        Returns:
        location
      • setStoreId

        public void setStoreId(java.lang.Integer aStoreId)
        Set the store ID for the gift registry
        Parameters:
        storeId -
      • getStoreId

        public java.lang.Integer getStoreId()
        Gets the store ID of the gift registry
        Returns:
        storeId
      • getStatus

        public java.lang.Integer getStatus()
        Gets the status of the gift registry
        Returns:
        status
      • setStatus

        public void setStatus(java.lang.Integer status)
        Sets the status of the gift registry
        Parameters:
        status -
      • setField1

        public void setField1(java.lang.Integer value)
        Set the value of the gift registry customizable field 1
        Parameters:
        field1 -
      • getField1

        public java.lang.Integer getField1()
        Gets the value of the gift registry customizable field 1
        Returns:
        field1
      • setField2

        public void setField2(java.lang.Integer value)
        Set the value of the gift registry customizable field 2
        Parameters:
        field2 -
      • getField2

        public java.lang.Integer getField2()
        Gets the value of the gift registry customizable field 2
        Returns:
        field2
      • setField3

        public void setField3(java.lang.String value)
        Set the value of the gift registry customizable field 3
        Parameters:
        field3 -
      • getField3

        public java.lang.String getField3()
        Gets the value of the gift registry customizable field 3
        Returns:
        field3
      • setField4

        public void setField4(java.lang.String value)
        Set the value of the gift registry customizable field 4
        Parameters:
        field4 -
      • getField4

        public java.lang.String getField4()
        Gets the value of the gift registry customizable field 4
        Returns:
        field4
      • setField5

        public void setField5(java.lang.String value)
        Set the value of the gift registry customizable field 5
        Parameters:
        field5 -
      • getField5

        public java.lang.String getField5()
        Gets the value of the gift registry customizable field 5
        Returns:
        field5
      • getGuestAccessKey

        public java.lang.String getGuestAccessKey()
        Gets the guest access key of the gift registry
        Returns:
        guestAccessKey
      • setRegistrantAccessKey

        public void setRegistrantAccessKey(java.lang.String value)
        Sets the guest access key of the gift registry
        Parameters:
        guestAccessKey -
      • getRegistrantAccessKey

        public java.lang.String getRegistrantAccessKey()
        Gets the registrant access key of the gift registry
        Returns:
        registrantAccessKey
      • setGuestAccessKey

        public void setGuestAccessKey(java.lang.String value)
        Sets the registrant access key of the gift registry
        Parameters:
        registrantAccessKey -
      • getRegistrantPassword

        public java.lang.String getRegistrantPassword()
        Gets the registrant password of the gift registry
        Returns:
        registrantPassword
      • setRegistrantPassword

        public void setRegistrantPassword(java.lang.String choice)
        Sets the registrant password of the gift registry
        Parameters:
        registrantPassword -
      • getCoRegistrantPassword

        public java.lang.String getCoRegistrantPassword()
        Gets the co-registrant password of the gift registry
        Returns:
        coRegistrantPassword
      • setCoRegistrantPassword

        public void setCoRegistrantPassword(java.lang.String choice)
        Sets the co-registrant password of the gift registry
        Parameters:
        coRegistrantPassword -
      • getGuestPassword

        public java.lang.String getGuestPassword()
        Gets the guest password of the gift registry
        Returns:
        guestPassword
      • setGuestPassword

        public void setGuestPassword(java.lang.String choice)
        Sets the guest password of the gift registry
        Parameters:
        guestPassword -
      • setPreEventShippingAddress

        public void setPreEventShippingAddress(GiftRegistryAddressVO addressVO)
        Set the pre-event shipping address of the gift registry
        Parameters:
        addressVO -
      • setPostEventShippingAddress

        public void setPostEventShippingAddress(GiftRegistryAddressVO addressVO)
        Set the post-event shipping address of the gift registry
        Parameters:
        addressVO -
      • getPreEventShippingAddress

        public GiftRegistryAddressVO getPreEventShippingAddress()
        Gets the pre-event shipping address
        Returns:
        preEventShippingAddress
      • getPostEventShippingAddress

        public GiftRegistryAddressVO getPostEventShippingAddress()
        Gets the post-event shipping address
        Returns:
        postEventShippingAddress
      • getId

        public java.lang.Object getId()
        Get the ID of the gift registry
        Specified by:
        getId in class BaseVO
        Returns:
        id
      • isNew

        public boolean isNew()
        Description copied from class: BaseVO
        Checks if a value object is newly created. The default rule is that a value object is new if and only its ID has been set. If the ID is represented by a String, it can't be an empty string.
        Overrides:
        isNew in class BaseVO
        Returns:
        true if a gift registry has neither giftRegistryId nor externalId
      • getType

        public java.lang.Integer getType()
        Gets the registry type
        Returns:
        the type of the gift registry
      • setType

        public void setType(java.lang.Integer type)
        Sets the registry type
        Parameters:
        type -
      • getUpdatedTime

        public java.sql.Timestamp getUpdatedTime()
        Gets the last update time of the gift registry
        Returns:
        updatedTime
      • setUpdatedTime

        public void setUpdatedTime(java.sql.Timestamp time)
        Sets the last update time of the gift registry
        Parameters:
        updatedTime -
      • setPreEventShippingPreference

        public void setPreEventShippingPreference(java.lang.String preference)
        Sets the pre-event shipping preference
        Parameters:
        preEventShippingPreference -
      • getPreEventShippingPreference

        public java.lang.String getPreEventShippingPreference()
        Gets the pre-event shipping preference
        Returns:
        preEventShippingPreference
      • setPostEventShippingPreference

        public void setPostEventShippingPreference(java.lang.String preference)
        Sets the post-event shipping preference
        Parameters:
        postEventShippingPreference -
      • getPostEventShippingPreference

        public java.lang.String getPostEventShippingPreference()
        Gets the post-event shipping preference
        Returns:
        postEventShippingPreference