|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This context object provides an API to instruct the ValueListHandler on what data to retrieve and how to retrieve it.
Field Summary | |
static int |
UNDEFINED_MAX_ROWS
Specifies that the max rows is undefined. |
Method Summary | |
java.lang.String |
getListID()
This method retrieves the unique ID associated with this is list context. |
int |
getMaxValues()
Gets the maximum number of values that should be returned for the list. |
java.lang.Object |
getSearchCriteria()
The incoming object should provide the necessary details to instruct the ValueListHandler service on where to go and how to query for the value objects. |
boolean |
moreValues()
Determines whether the incoming search request is asking for the next set of values associated with this list id. |
void |
setGetMoreValues(boolean ab_more_values)
Sets whether the ValueListHandler should retrieve the next set of values for an existing list id. |
void |
setListID(java.lang.String as_id)
This method assigns an ID to the eventual list of value objects that will be returned after calling the ValueListHandler.getValueObjects() method. |
void |
setMaxValues(int ai_max_values)
Set the maximum number of values that should be returned for the list. |
void |
setSearchCriteria(java.lang.Object ao_search_criteria)
The incoming object should provide the necessary details to instruct the ValueListHandler service on where to go and how to query for the value objects. |
Field Detail |
public static final int UNDEFINED_MAX_ROWS
Method Detail |
public void setListID(java.lang.String as_id)
as_id
- A unique identifier for the list being returned.
java.lang.IllegalArgumentException
- If the list id is null or empty.public java.lang.String getListID() throws java.lang.IllegalStateException
java.lang.IllegalStateException
- If the id is not specified.public void setMaxValues(int ai_max_values) throws java.lang.IllegalArgumentException
ai_max_values
- The maximum number of rows to return in a list.
java.lang.IllegalArgumentException
- If a negative number or zero is provided.public int getMaxValues()
public void setSearchCriteria(java.lang.Object ao_search_criteria) throws java.lang.IllegalArgumentException
ao_search_criteria
- A generic object.
java.lang.IllegalArgumentException
- If the incoming search criteria is null.public java.lang.Object getSearchCriteria() throws java.lang.IllegalStateException
java.lang.IllegalStateException
- If the incoming search criteria is null.public void setGetMoreValues(boolean ab_more_values)
ab_more_values
- True if more values should be returned, False if
this is the initial request.public boolean moreValues()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |