public class GiftRegistrySearchDataBeanBase extends SmartDataBeanImpl implements SmartDataBean, InputDataBean
userId
firstName
lastName
email1
eventMonth
eventYear
eventDay
state
country
externalId
eventType_id
startIndex
maxResultsPerPage
getRegistries()
to
conduct a search and retrieve a list of GiftRegistryDataBeans
, or call
findGiftRegistries()
to get a list of GiftRegistryId found.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASSNAME
The Classname.
|
static java.lang.String |
COPYRIGHT
IBM copyright notice field.
|
emptyString
Constructor and Description |
---|
GiftRegistrySearchDataBeanBase()
Default constructor
|
Modifier and Type | Method and Description |
---|---|
CommandContext |
getCommandContext()
Gets the command context set within this bean.
|
java.lang.String |
getCountry()
Gets the country being searched on if set.
|
int |
getCurrentPageNumber()
Returns the current page number in the result set (based on page size -- if page size is zero or null, this function returns 1)
|
java.lang.String |
getEmail1()
Gets an email address being searched on if set.
|
int |
getEndIndex()
Returns the end index for the result set on the page.
|
java.lang.String |
getEventDay()
Gets the event day being searched on if set.
|
java.lang.String |
getEventMonth()
Gets the event month being searched on if set.
|
java.lang.String |
getEventTypeId()
Gets the ID of the gift registry's event type
|
java.lang.String |
getEventYear()
Gets the event year being searched on if set.
|
java.lang.String |
getExternalId()
Gets the gift registry externalId being searched on if set.
|
boolean |
getFindSimilarMatches()
Gets similar search result value.
|
java.lang.String |
getFirstName()
Gets the first name being searched on if set.
|
int[] |
getGuestOption()
Gets the guestOption of a gift registry to search for.
|
java.lang.String |
getLastName()
Gets the last name being searched on if set.
|
java.lang.String |
getMaxResultsPerPage()
Gets the maximum results to display per page.
|
int |
getNumberOfResultsOnPage()
Returns the number of results that are available on
this particular page.
|
GiftRegistryDataBean[] |
getRegistries()
Returns matches for the specified search criteria
|
TypedProperty |
getRequestProperties()
Returns the request properties of the data bean.
|
int |
getResultCount()
Returns the total number of results that were found matching the query
specified.
|
java.lang.String |
getSortBy()
An integer index into the following list of sortable criteria supported in this bean.
|
java.lang.String |
getSortByFieldName()
Gets the sortBy field name
|
java.lang.String |
getSortByTableName()
Gets the Sort By table name
|
java.lang.String |
getSortByType()
Gets the registrant type used for the sorting.
|
java.lang.String |
getStartIndex()
Gets the index of the first search result returned
|
java.lang.String |
getState()
Gets the state to be searched on if set
|
int[] |
getStatus()
Gets the status of a gift registry to search for.
|
java.lang.String |
getStoreId()
Gets the storeId to run the search against
|
int |
getTotalPages()
Returns the number of pages that are in this result count.
|
int[] |
getType()
Gets the type of a gift registry to search for.
|
java.lang.String |
getUserId()
Gets the userId being searched on if set.
|
boolean |
isFindSimilarMatches()
Returns true if this bean is set to search for similar
results.
|
boolean |
isNextPageExists()
Determines whether a next page of data exists
|
boolean |
isPreviousPageExists()
Determines whether a previous page of data exists
|
void |
populate()
Populates the data bean
|
void |
setCommandContext(CommandContext commandContext)
Sets the command context.
|
void |
setCountry(java.lang.String string)
Sets the country to be searched on if set
|
void |
setEmail1(java.lang.String string)
Sets an e-mail address to be searched on
|
void |
setEventDay(java.lang.String string)
Sets the country to be searched on if set
|
void |
setEventMonth(java.lang.String string)
Sets the event month to be searched on if set
|
void |
setEventTypeId(java.lang.String id)
Sets the ID of the event type that is associated with the gift registry
|
void |
setEventYear(java.lang.String string)
Sets the event year to be searched on if set
|
void |
setExternalId(java.lang.String string)
Sets the gift registry externalId to be searched on
|
void |
setFindSimilarMatches(boolean bSimilarMatches)
Sets this bean to search for similar search results.
|
void |
setFirstName(java.lang.String string)
Sets the first name to be searched on if set
|
void |
setGuestOption(int[] integer)
Sets the guestOption of a gift registry to search for.
|
void |
setLastName(java.lang.String string)
Sets the last name to be searched on if set
|
void |
setMaxResultsPerPage(java.lang.String string)
Sets the maximum results to display per page.
|
void |
setRequestProperties(TypedProperty param)
Sets the requestProperties associated
with the data bean.
|
void |
setResetSearchBean()
Resets this bean.
|
void |
setSortBy(java.lang.String string)
Sets an integer index into the following list of sortable criteria supported in this bean.
|
void |
setSortByFieldName(java.lang.String aSortByFieldName)
Set the sortBy field name.
|
void |
setSortByTableName(java.lang.String aSortByTableName)
Sets the Sort By table name.
|
void |
setSortByType(java.lang.String aSortByRegistrantType)
Sets the registrant type used for the sorting.
|
void |
setStartIndex(java.lang.String string)
Sets the index of the first search result to return.
|
void |
setState(java.lang.String string)
Sets the state to be searched on if set
|
void |
setStatus(int[] integer)
Sets the status of a gift registry to search for.
|
void |
setStoreId(java.lang.String string)
Sets the storeId to run the search against
|
void |
setType(int[] integer)
Sets the type of a gift registry to search for.
|
void |
setUserId(java.lang.String string)
Sets the userId to be searched on
|
fulfills, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext
public static final java.lang.String COPYRIGHT
public static final java.lang.String CLASSNAME
public GiftRegistrySearchDataBeanBase()
public CommandContext getCommandContext()
getCommandContext
in interface SmartDataBean
getCommandContext
in class SmartDataBeanImpl
CommandContext
object.public void setCommandContext(CommandContext commandContext)
setCommandContext
in interface SmartDataBean
setCommandContext
in class SmartDataBeanImpl
commandContext
- The command context..public TypedProperty getRequestProperties()
getRequestProperties
in interface InputDataBean
getRequestProperties
in class InputDataBeanImpl
public void setRequestProperties(TypedProperty param) throws java.lang.Exception
setRequestProperties
in interface InputDataBean
setRequestProperties
in class InputDataBeanImpl
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
populate
in class SmartDataBeanImpl
java.lang.Exception
public GiftRegistryDataBean[] getRegistries()
public void setResetSearchBean()
public int getResultCount()
public int getTotalPages()
public int getCurrentPageNumber()
public int getEndIndex()
public boolean isPreviousPageExists()
public boolean isNextPageExists()
public java.lang.String getCountry()
public void setCountry(java.lang.String string)
country
- public java.lang.String getEventDay()
public void setEventDay(java.lang.String string)
string
- public java.lang.String getEventMonth()
public void setEventMonth(java.lang.String string)
eventMonth
- public java.lang.String getEventYear()
public void setEventYear(java.lang.String string)
eventYear
- public java.lang.String getFirstName()
public void setFirstName(java.lang.String string)
firstName
- public java.lang.String getLastName()
public void setLastName(java.lang.String string)
lastName
- public java.lang.String getState()
public void setState(java.lang.String string)
state
- public java.lang.String getUserId()
public void setUserId(java.lang.String string)
userId
- public void setEventTypeId(java.lang.String id)
id
- the ID of the event typepublic java.lang.String getEventTypeId()
public java.lang.String getExternalId()
public void setExternalId(java.lang.String string)
externalId
- public java.lang.String getEmail1()
public void setEmail1(java.lang.String string)
email1
- public java.lang.String getMaxResultsPerPage()
public void setMaxResultsPerPage(java.lang.String string)
maxResultsPerPage
- public java.lang.String getStartIndex()
public void setStartIndex(java.lang.String string)
string
- public java.lang.String getStoreId()
public void setStoreId(java.lang.String string)
storeId
- public java.lang.String getSortBy()
public void setSortBy(java.lang.String string)
sortBy
- public int[] getStatus()
public void setStatus(int[] integer)
status
- public int[] getType()
public void setType(int[] integer)
type
- public int[] getGuestOption()
public void setGuestOption(int[] integer)
guestOption
- public boolean isFindSimilarMatches()
public void setFindSimilarMatches(boolean bSimilarMatches)
true
means to search for similar results.
false
means to search only for exact results.bSimilarMatches
- public boolean getFindSimilarMatches()
true
means to search for similar results.
false
means to search only for exact results.public int getNumberOfResultsOnPage()
public java.lang.String getSortByType()
public void setSortByType(java.lang.String aSortByRegistrantType)
registrant
- type: R for registrant and C for co-registrantpublic java.lang.String getSortByTableName()
public void setSortByTableName(java.lang.String aSortByTableName)
the
- Sort By table name.public java.lang.String getSortByFieldName()
public void setSortByFieldName(java.lang.String aSortByFieldName)
the
- sortBy field name.