com.ibm.commerce.giftregistry.beans

Class GiftRegistryContextDataBean

  • java.lang.Object
    • com.ibm.commerce.giftregistry.beans.GiftRegistryContextDataBean
    • Field Detail

      • COPYRIGHT

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

      • GiftRegistryContextDataBean

        public GiftRegistryContextDataBean()
        Generates an empty GiftRegistryContextDataBean.
    • Method Detail

      • 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..
      • setRequestProperties

        public void setRequestProperties(TypedProperty param)
                                  throws java.lang.Exception
        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.
      • populate

        public void populate()
                      throws java.lang.Exception
        Populates the data bean
        Specified by:
        populate in interface SmartDataBean
        Throws:
        java.lang.Exception
      • getLastAccessedExternalId

        public java.lang.String getLastAccessedExternalId()
        Returns the last gift registry External ID that the user accessed (or viewed)
        Returns:
        The last gift registry External ID that the user accessed (or viewed)
      • getCurrentExternalId

        public java.lang.String getCurrentExternalId()
        Returns the current gift registry External ID that the user accessed (or viewed)
        Returns:
        The current gift registry External ID that the user accessed (or viewed)
      • getNumberOfAccessedGiftRegistries

        public int getNumberOfAccessedGiftRegistries()
        Returns the number of gift registries this user has accessed in this session.
        Returns:
        The number of registries this user has accessed
      • getLastAccessedGiftRegistryDataBean

        public GiftRegistryDataBean getLastAccessedGiftRegistryDataBean()
        Returns a GiftRegistryDataBean representing the last Registry that the user accessed (or viewed)
        Returns:
        The GiftRegistryDataBean representing the last Registry that the user accessed (or viewed)
      • getAccessedGiftRegistryDataBeans

        public GiftRegistryDataBean[] getAccessedGiftRegistryDataBeans()
        Returns an array of GiftRegistryDataBeans for all the Registry's this user accessed their current session
        Returns:
        an array of GiftRegistryDataBeans
      • getAccessedGiftRegistryDataBeansByRegistrantRelationship

        public GiftRegistryDataBean[] getAccessedGiftRegistryDataBeansByRegistrantRelationship()
        Returns an array of GiftRegistryDataBean's for all the Registry's this user accessed their current session for which they have a Registrant or Co-Registrant authority on
        Returns:
        GiftRegistryDataBean[]
      • getAccessedExternalIds

        public java.util.Enumeration getAccessedExternalIds()
        Returns a vector of all the gift registry external IDs that this user accessed during this session
        Returns:
        Enumeration of gift registry external IDs
      • getExternalIdsByRegistrantRelationship

        public java.util.Enumeration getExternalIdsByRegistrantRelationship()
        Returns a list of gift registry external IDs with which this user has a registrant or co-registrant relationship
        Returns:
        Enumeration of External IDs - A list of gift registry externalId that this user has the Registrant or Co-Registrant relationship with
      • getNumberOfExternalIdsByRegistrantRelationship

        public int getNumberOfExternalIdsByRegistrantRelationship()
        Gets the number of gift registries this user has accessed in the current session
        Returns:
        The number of gift registries this user has accessed in the current session
      • isUserManagingARegistry

        public boolean isUserManagingARegistry()
        Returns true if the user is currently managing a registry. The registry user is managing can be found by calling: getGiftRegistryBeingManaged() If this is true, it means that the user is adding items to their registry.
        Returns:
        A Boolean. True: user is managing the registry. False: user is not managing the registry.
      • getGiftRegistryBeingManaged

        public java.lang.String getGiftRegistryBeingManaged()
        If isUserManagingARegistry() is true, it means that a gift registry is being managed by a user. This method can then be called to retrieve the gift registry's external ID that the user is managing.
        Returns:
        externalId - The gift registry's external ID that the user is managing.
      • getGiftRegistryOwned

        public java.util.Enumeration getGiftRegistryOwned()
        Returns all GiftRegistryDataBeans that were found to be owned by the user
        Returns:
        Enumeration for GiftRegistryDataBean
      • getDataBeansForOwnedGiftRegistries

        public GiftRegistryDataBean[] getDataBeansForOwnedGiftRegistries()
        Returns the list of gift registry GiftRegistryDataBean values based on the users ID
        Returns:
        array for GiftRegistryDataBean