|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.itim.apps.search.SearchResultsMO
SearchResultsMO
Field Summary | |
com.ibm.itim.apps.impl.PlatformContextImpl |
platform
|
javax.security.auth.Subject |
subject
|
Constructor Summary | |
SearchResultsMO(PlatformContext platform,
javax.security.auth.Subject subject)
Constructs the the managed object with a platform context and a subject. |
Method Summary | |
void |
close()
Releases this SearchResultsMO EJB resources (removes the stateful session bean instance associated with this SearchResultsMO). |
java.util.Collection |
getPage(int pageNo)
Returns the specified page of the result set. |
int |
getPageCount()
Returns the number of pages in the result set. |
int |
getPageCount(int lookaheadLimit)
Get the number of available pages up to a look-ahead limit. |
java.util.Collection |
getResults()
Returns all of the results. |
SearchResultsStatus |
getSearchResultsStatus()
Gets the SearchResultsStatus. |
void |
reverseSortResults()
Reverses the the sorting order of the search results. |
void |
setSearchResults(java.util.Collection results)
Holds the given results in this SearchResultsMO |
void |
setSearchResultsStatus(SearchResultsStatus sResultsStatus)
Sets the SearchResultsStatus. |
void |
sortResults(java.lang.String attribute,
int order)
Resorts by the given sort attribute and order (ascending vs. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public javax.security.auth.Subject subject
public com.ibm.itim.apps.impl.PlatformContextImpl platform
Constructor Detail |
public SearchResultsMO(PlatformContext platform, javax.security.auth.Subject subject)
platform
- PlatformContext holding platform connection information.subject
- Subject representing the authenticated caller.Method Detail |
public void setSearchResults(java.util.Collection results) throws java.rmi.RemoteException, ApplicationException
results
- Collection of DirectoryObjectEntityjava.rmi.RemoteException
- thrown if unable to communicate with the
platformApplicationException
- if an error prevents the given
results from being associated with a SearchAuthority
bean instance.public int getPageCount() throws java.rmi.RemoteException, ApplicationException, java.lang.IllegalStateException
Performance Note: Users of this method should note that in many cases, the page count cannot be determined by the system without loading the complete result set from the underlying database or directory. This can lead to performance and scaling problems when the result set size is very large. If there is reason to believe that the result set could be large then is is recommended that users take advantage of the getPageCount(int lookaheadLimit) method that allows an upper bound on the amount of lookahead that the system will perform to determine the page count.
java.rmi.RemoteException
- Thrown if unable to communicate with platform.getPageCount(int)
public int getPageCount(int lookaheadLimit) throws java.rmi.RemoteException, ApplicationException, java.lang.IllegalStateException
lookaheadLimit
- The number of pages to advance through the result set in order
to determine the available page count.java.rmi.RemoteException
- Thrown if unable to communicate with platform.ApplicationException
- If there is a problem performing this operation
at the server.java.lang.IllegalStateException
- If the internal state of this object is inconsistent.
This generally means that the handle for the server bean cannot be found.getPageCount()
public java.util.Collection getPage(int pageNo) throws java.rmi.RemoteException, ApplicationException, java.lang.IllegalStateException
pageNo
- The number of the page to return.java.rmi.RemoteException
- Thrown if unable to communicate with platform.public java.util.Collection getResults() throws java.rmi.RemoteException, ApplicationException, java.lang.IllegalStateException
java.rmi.RemoteException
- Thrown if unable to communicate with platform.public void sortResults(java.lang.String attribute, int order) throws java.rmi.RemoteException, ApplicationException, java.lang.IllegalStateException
attribute
- Name of the attribute to sort by.order
- Enumeration of the order to sort by. Value may be either
SearchMO.ASCENDING_SORT or
SearchMO.DESCENDING_SORT.java.rmi.RemoteException
- Thrown if unable to communicate with platform.ApplicationException
- Thrown if unable to resort. This is most
likely caused by either an invalid
sort attribute name or invalid sort
order.public void reverseSortResults() throws java.rmi.RemoteException, ApplicationException, java.lang.IllegalStateException
java.rmi.RemoteException
- Thrown if unable to communicate with platform.public void close() throws java.rmi.RemoteException, ApplicationException
java.rmi.RemoteException
- Thrown if unable to communicate with platform.ApplicationException
- Thrown if unable remove the bean.public void setSearchResultsStatus(SearchResultsStatus sResultsStatus)
sResultsStatus
- A SearchResultsStatus instance, or null of not
applicable to the search request.public SearchResultsStatus getSearchResultsStatus()
sResultsStatus
- A SearchResultsStatus instance, or null of not
applicable to the search request.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |