public class GiftRegistryContextDataBean extends java.lang.Object implements SmartDataBean, InputDataBean
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM copyright notice field.
|
emptyString
Constructor and Description |
---|
GiftRegistryContextDataBean()
Generates an empty GiftRegistryContextDataBean.
|
Modifier and Type | Method and Description |
---|---|
java.util.Enumeration |
getAccessedExternalIds()
Returns a vector of all the gift registry external IDs that this user accessed during this session
|
GiftRegistryDataBean[] |
getAccessedGiftRegistryDataBeans()
Returns an array of GiftRegistryDataBeans for all the Registry's this user accessed their current session
|
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 |
CommandContext |
getCommandContext()
Gets the command context set within this bean.
|
java.lang.String |
getCurrentExternalId()
Returns the current gift registry External ID that the user accessed (or viewed)
|
GiftRegistryDataBean[] |
getDataBeansForOwnedGiftRegistries()
Returns the list of gift registry
GiftRegistryDataBean values based on the users ID |
java.util.Enumeration |
getExternalIdsByRegistrantRelationship()
Returns a list of gift registry external IDs with which this user has a registrant or
co-registrant relationship
|
java.lang.String |
getGiftRegistryBeingManaged()
If
isUserManagingARegistry() is true, it means that a gift registry is being
managed by a user. |
java.util.Enumeration |
getGiftRegistryOwned()
Returns all
GiftRegistryDataBeans that were found to be owned by the user |
java.lang.String |
getLastAccessedExternalId()
Returns the last gift registry External ID that the user accessed (or viewed)
|
GiftRegistryDataBean |
getLastAccessedGiftRegistryDataBean()
Returns a GiftRegistryDataBean representing the last Registry that the user accessed (or viewed)
|
int |
getNumberOfAccessedGiftRegistries()
Returns the number of gift registries this user has accessed in this session.
|
int |
getNumberOfExternalIdsByRegistrantRelationship()
Gets the number of gift registries this user has accessed in the current session
|
TypedProperty |
getRequestProperties()
Returns the request properties of the data bean.
|
boolean |
isUserManagingARegistry()
Returns true if the user is currently managing a registry.
|
void |
populate()
Populates the data bean
|
void |
setCommandContext(CommandContext commandContext)
Sets the command context.
|
void |
setRequestProperties(TypedProperty param)
Sets the request properties within this bean.
|
public static final java.lang.String COPYRIGHT
public GiftRegistryContextDataBean()
public CommandContext getCommandContext()
getCommandContext
in interface SmartDataBean
CommandContext
object.public void setCommandContext(CommandContext commandContext)
setCommandContext
in interface SmartDataBean
commandContext
- The command context..public TypedProperty getRequestProperties()
getRequestProperties
in interface InputDataBean
public void setRequestProperties(TypedProperty param) throws java.lang.Exception
setRequestProperties
in interface InputDataBean
requestProperties
- the set of properties passed to the JSP
page that invokes this data bean,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.public void populate() throws java.lang.Exception
populate
in interface SmartDataBean
java.lang.Exception
public java.lang.String getLastAccessedExternalId()
public java.lang.String getCurrentExternalId()
public int getNumberOfAccessedGiftRegistries()
public GiftRegistryDataBean getLastAccessedGiftRegistryDataBean()
public GiftRegistryDataBean[] getAccessedGiftRegistryDataBeans()
public GiftRegistryDataBean[] getAccessedGiftRegistryDataBeansByRegistrantRelationship()
GiftRegistryDataBean
's for all the Registry's this user accessed their current session
for which they have a Registrant or Co-Registrant authority onpublic java.util.Enumeration getAccessedExternalIds()
public java.util.Enumeration getExternalIdsByRegistrantRelationship()
public int getNumberOfExternalIdsByRegistrantRelationship()
public boolean isUserManagingARegistry()
getGiftRegistryBeingManaged()
If this is true, it means that the user is adding items to their registry.public java.lang.String getGiftRegistryBeingManaged()
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.public java.util.Enumeration getGiftRegistryOwned()
GiftRegistryDataBeans
that were found to be owned by the userpublic GiftRegistryDataBean[] getDataBeansForOwnedGiftRegistries()
GiftRegistryDataBean
values based on the users ID