com.ibm.commerce.giftregistry.beans

Class GiftRegistryDataBean

    • Field Detail

      • COPYRIGHT

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

      • GiftRegistryDataBean

        public GiftRegistryDataBean()
        Generates an empty GiftRegistryDataBean
    • Method Detail

      • setRequestProperties

        public void setRequestProperties(TypedProperty param)
        Sets the request properties within this bean.
        Specified by:
        setRequestProperties in interface InputDataBean
        Parameters:
        requestProperties - the set of properties passed to the JSP page that invokes this data bean,
        Throws:
        java.lang.Exception - if there is a problem when setting the request properties. This particular method should not throw any exception because it just stores the request properties.
      • getCommandContext

        public CommandContext getCommandContext()
        Gets the command context set within this bean.
        Specified by:
        getCommandContext in interface SmartDataBean
        Returns:
        The command context as CommandContext object.
      • setCommandContext

        public void setCommandContext(CommandContext commandContext)
        Sets the command context.
        Specified by:
        setCommandContext in interface SmartDataBean
        Parameters:
        commandContext - The command context..
      • populate

        public void populate()
        Populates the data bean with data elements.
        Specified by:
        populate in interface SmartDataBean
        Throws:
        java.lang.Exception - if there is a problem populating the data bean with data.
      • getAcceptGiftCard

        public java.lang.Integer getAcceptGiftCard()
        Get the gift registry acceptGiftCard value
        Overrides:
        getAcceptGiftCard in class GiftRegistryAccessBean
        Returns:
        Returns the gift registry acceptGiftCard value
      • getRegistrantAccessKey

        public java.lang.String getRegistrantAccessKey()
        Gets the gift registry registrant's access key value
        Overrides:
        getRegistrantAccessKey in class GiftRegistryAccessBean
        Returns:
        the gift registry registrant's access key value
      • getLocation

        public java.lang.String getLocation()
        Get the location of where the gift registry was created, for example (OnLine, store1, store2 and so forth.).
        Overrides:
        getLocation in class GiftRegistryAccessBean
        Returns:
        The location of where the gift registry was created.
      • getCreatedTime

        public java.sql.Timestamp getCreatedTime()
        The time at which the gift registry was created.
        Overrides:
        getCreatedTime in class GiftRegistryAccessBean
        Returns:
        The time at which the gift registry was created.
      • getDescription

        public java.lang.String getDescription()
        Gets the gift registry description
        Overrides:
        getDescription in class GiftRegistryAccessBean
        Returns:
        The gift registry description
      • getEventDate

        public java.sql.Date getEventDate()
        Gets the gift registry eventDate date
        Overrides:
        getEventDate in class GiftRegistryAccessBean
        Returns:
        The gift registry eventDate date
      • getEventTypeId

        public java.lang.Integer getEventTypeId()
        Gets the gift registry eventTypeId
        Overrides:
        getEventTypeId in class GiftRegistryAccessBean
        Returns:
        Returns the gift registry eventTypeId
      • getEventTypeName

        public java.lang.String getEventTypeName()
        Gets the gift registry event type name
        Returns:
        The gift registry event type name
      • getExternalId

        public java.lang.String getExternalId()
        Gets the gift registry external ID
        Overrides:
        getExternalId in class GiftRegistryAccessBean
        Returns:
        The gift registry external ID
      • getField1

        public java.lang.Integer getField1()
        Gets the gift registry field1 value
        Overrides:
        getField1 in class GiftRegistryAccessBean
        Returns:
        The gift registry field1 value
      • getField2

        public java.lang.Integer getField2()
        Gets the gift registry field2 value
        Overrides:
        getField2 in class GiftRegistryAccessBean
        Returns:
        The gift registry field2 value
      • getField3

        public java.lang.String getField3()
        Gets the gift registry field3 value
        Overrides:
        getField3 in class GiftRegistryAccessBean
        Returns:
        The gift registry field3 value
      • getField4

        public java.lang.String getField4()
        Gets the gift registry field4 value
        Overrides:
        getField4 in class GiftRegistryAccessBean
        Returns:
        The gift registry field4 value
      • getField5

        public java.lang.String getField5()
        Gets the gift registry field5 value
        Overrides:
        getField5 in class GiftRegistryAccessBean
        Returns:
        The gift registry field5 value
      • getGuestAccessOption

        public java.lang.Integer getGuestAccessOption()
        Gets the gift registry guestAccessOption value:
        • 0: The gift registry is public. It can be searched or viewed by anyone.
        • 1: The gift registry can not be searched but is not password protected.
        • 2: The gift registry is password protected, but searchable.
        Overrides:
        getGuestAccessOption in class GiftRegistryAccessBean
        Returns:
        The gift registry guestAccessOption value
      • getLastUpdate

        public java.sql.Timestamp getLastUpdate()
        Gets the last updated timestamp of a gift registry
        Overrides:
        getLastUpdate in class GiftRegistryAccessBean
        Returns:
        The last updated timestamp of a gift registry
      • getMessageForGuest

        public java.lang.String getMessageForGuest()
        Gets the gift registry's message for guest.
        Overrides:
        getMessageForGuest in class GiftRegistryAccessBean
        Returns:
        The gift registry's message for guest
      • getName

        public java.lang.String getName()
        Gets the gift registry's name
        Overrides:
        getName in class GiftRegistryAccessBean
        Returns:
        The gift registry's name
      • getOptForEmail

        public java.lang.Integer getOptForEmail()
        Gets the value of the option for e-mail of the gift registry:
        • 0: The registrant does not want to receive e-mail.
        • 1: The registrant wants to receive e-mail.
        Overrides:
        getOptForEmail in class GiftRegistryAccessBean
        Returns:
        The gift registry optForEmail value
      • getStatus

        public java.lang.Integer getStatus()
        Gets the gift registry status:
        • 0: The gift registry is not active (that is, it is disabled). Only the merchant can activate the registry.
        • 1: The gift registry is active.
        • 2. The gift registry is completed.
        • 3: The gift registry has expired.
        • 4: The gift registry is marked for deletion.
        Overrides:
        getStatus in class GiftRegistryAccessBean
        Returns:
        The gift registry status
      • getStoreId

        public java.lang.Integer getStoreId()
        Gets the store ID to which this gift registry belongs.
        Overrides:
        getStoreId in class GiftRegistryAccessBean
        Returns:
        the store ID to which this gift registry belongs.
      • getType

        public java.lang.Integer getType()
        Gets the gift registry type
        Overrides:
        getType in class GiftRegistryAccessBean
        Returns:
        The gift registry type
      • getGuestAccessKey

        public java.lang.String getGuestAccessKey()
        Gets the Guest's access key on this registry
        Overrides:
        getGuestAccessKey in class GiftRegistryAccessBean
        Returns:
        The Guest's access key on this registry
      • getIsEligible

        public java.lang.String getIsEligible()
        Gets the isEligible value
        Returns:
        The isEligible value
      • setRegistrantAccessKey

        public void setRegistrantAccessKey(java.lang.String newValue)
        Sets the gift registry access key value
        Overrides:
        setRegistrantAccessKey in class GiftRegistryAccessBean
        Parameters:
        newValue - - the gift registry access key value
      • setExternalId

        public void setExternalId(java.lang.String newValue)
        Sets the gift registry externalId value
        Overrides:
        setExternalId in class GiftRegistryAccessBean
        Parameters:
        newValue - - the gift registry externalId value
      • setGiftRegistryId

        public void setGiftRegistryId(java.lang.Long newValue)
        Sets the gift registry Id. Only valid before initialization of this bean
        Overrides:
        setGiftRegistryId in class GiftRegistryAccessBean
        Parameters:
        newValue - - the gift registry Id
      • getItems

        public GiftRegistryItemDataBean[] getItems()
        Returns all the items in this gift registry. Returns null if there are no items in the gift registry.
        Returns:
        an array of GiftRegitryItemDataBeans containing all the items in the gift registry. Returns null if there are no items in the gift registry.
      • getRegistrants

        public GiftRegistryRegistrantDataBean[] getRegistrants()
        Returns all the registrants related to this gift registry. Returns null if no registrants exist. Registrants are listed first followed by co-registrants.
        Returns:
        an array of GiftRegistryRegistrantDataBean - all the registrants related to this gift registry
      • getAnnouncements

        public GiftRegistryAnnouncementHistoryDataBean[] getAnnouncements()
        Gets a list of announcement history beans
        Returns:
        GiftRegistryAnnouncementHistoryDataBean[] - a list of announcement history beans
      • isEligibleForPostEventProgram

        public java.lang.String isEligibleForPostEventProgram()
        Checks the registry is eligible for a post event program or not
        Returns:
        The state to indicate the registry is eligible for a post event program or not
      • getInEligiblePostEventProgramMsg

        public java.lang.String getInEligiblePostEventProgramMsg()
        Gets the String value that indicates the registry is eligible for a post event program or not
        Returns:
        The String value that indicates the registry is eligible for a post event program or not
      • getRegistrantPassword

        public java.lang.String getRegistrantPassword()
        Gets the registrant password for this registry
        Returns:
        The registrant password for this registry
      • getGiftGiverPassword

        public java.lang.String getGiftGiverPassword()
        Gets the gift giver password for this registry
        Returns:
        The gift giver password for this registry
      • getPreShippingPreference

        public java.lang.String getPreShippingPreference()
        Returns the registry pre event shipping address reference: R: Registrant C: Co-registrant CU: 2nd co-registrant O: Other
        Returns:
        The registry pre event shipping address reference: R , C, CU, or O
      • getPostShippingPreference

        public java.lang.String getPostShippingPreference()
        Gets the registry post event shipping address reference: R: Registrant C: Co-registrant CU: 2nd co-registrant O: Other
        Returns:
        The registry post event shipping address reference: R , C, CU, or O
      • getShippingOffset

        public java.lang.Integer getShippingOffset()
        Gets the shipping offset. The shipping offset is used along with the current time and event date to determine whether the pre or post event shipping address is used. The default shipping offset value is 0.
        Returns:
        Integer shippingOffset in seconds
      • setShippingOffset

        public void setShippingOffset(java.lang.Integer offset)
        Sets the shipping offset. The shipping offset is used along with the current time and event date to determine whether the pre or post event shipping address is used.
        Parameters:
        offset - Integer shipping offset in seconds
      • getGiftRegistryPrePostShipAddress

        public GiftRegistryAddressDataBean getGiftRegistryPrePostShipAddress()
        Gets the appropriate shipping address (post-event or pre-event) by comparing the current time + shipping offset with the event date.
        Returns:
        GiftRegistryAddressDataBean shipping address for this gift registry
      • getRegistrantCity

        public java.lang.String getRegistrantCity()
        Gets the registrant's city for this registry
        Returns:
        The registrant's city for this registry
      • getRegistrantState

        public java.lang.String getRegistrantState()
        Gets the registrant's state for this registry
        Returns:
        The registrant's state for this registry