com.netegrity.llsdk6.imsapi.search
Class ApiResultSet

java.lang.Object
  com.netegrity.llsdk6.imsapi.search.ApiResultSet

Deprecated. As of FW 2.0, no alternate class exists.

Holds the result set for sorting and paging search operations.

The Identity Manager APIs use the sorting and paging capabilites of the target LDAP directory or ODBC database.

You can use SearchCursor to define sorting and paging behavior for the search... methods in the Identity Manager providers that retrieve managed objects -- that is, UserProvider, GroupProvider, and OrganizationProvider These search... methods return ApiResultSet objects.

public class ApiResultSet
extends java.lang.Object

Since:

IdentityMinder 6.0

Constructor Summary

ApiResultSet(java.util.Vector results, int totalSize, boolean bSorted, boolean bPaged, boolean bMoreResults)
Deprecated. Constructs an ApiResultSet object from an array of results, a total size, and paging and sorting flags.

Method Summary

java.util.Vector	getThisPage() Deprecated. Retrieves the current page of search results.
int	getTotalSize() Deprecated. Retrieves the total number of rows in the result set before paging.
boolean	isPaged() Deprecated. Specifies whether the result set was successfully paginated.
boolean	isSorted() Deprecated. Specifies whether the result set was successfully sorted.
boolean	morePages() Deprecated. Specifies whether there are more pages on the server.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiResultSet

public ApiResultSet(java.util.Vector results,
                    int totalSize,
                    boolean bSorted,
                    boolean bPaged,
                    boolean bMoreResults)

Deprecated.

Constructs an ApiResultSet object from an array of results, a total size, and paging and sorting flags.

Parameters:

results - An array of managed objects representing the current page of the results.

totalSize - The total number of query results.

bSorted - true if the results are actually sorted, or false otherwise.

bPaged - true if the results are actually paged, or false otherwise.

bMoreResults - true if there are more pages of results to be provided, or false otherwise.

Method Detail

getThisPage

public java.util.Vector getThisPage()

Deprecated.

Retrieves the current page of search results.

Returns:

A Vector of managed objects representing this page of the search results.

getTotalSize

public int getTotalSize()

Deprecated.

Retrieves the total number of rows in the result set before paging.

Returns:

The number of rows in the result set.

See Also:

getResultSize()

isSorted

public boolean isSorted()

Deprecated.

Specifies whether the result set was successfully sorted.

Returns:

true if the result set was successfully sorted, or false otherwise.

isPaged

public boolean isPaged()

Deprecated.

Specifies whether the result set was successfully paginated.

Returns:

true if the result set was successfully paginated, or false otherwise.

morePages

public boolean morePages()

Deprecated.

Specifies whether there are more pages on the server.

Returns:

true if there are more pages on the server