com.netegrity.llsdk6.imsapi.search
Class SearchCursor

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

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

Performs sorting and paging operations for search result sets.

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

You can use this object 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

public class SearchCursor
extends java.lang.Object

Since:

IdentityMinder 6.0

Constructor Summary

SearchCursor(java.util.Vector sort, int blockSize, boolean bSortingCr, boolean bPagingCr)
Deprecated. Constructs a SearchCursor object with a given sort order, block size (type int), and preferences regarding sorting and paging requirements.

SearchCursor(java.util.Vector sort, long blockSize, boolean bSortingCr, boolean bPagingCr)
Deprecated. Constructs a SearchCursor object with a given sort order, block size (type long), and preferences regarding sorting and paging requirements.

Method Summary

long	getOffset() Deprecated. Retrieves the starting offset of the block to be returned from the result set.
java.util.Hashtable	getProperties() Deprecated. For internal use only.
long	getRowsPerPage() Deprecated. Retrieves the maximum number of rows that can appear in a single page of search results.
java.util.Vector	getSortOrder() Deprecated. Retrieves the attribute names that define the sort order for the result set.
boolean	isPagingCritical() Deprecated. Indicates whether paging features are critical for a result set.
boolean	isSortingCritical() Deprecated. Indicates whether it is critical to sort a result set.
boolean	lockSortOrder() Deprecated. Locks the sort order.
void	setOffset(long size) Deprecated. Sets the starting offset of the block to be returned from the result set.
void	setRowsPerPage(long size) Deprecated. Sets the maximum number of rows that can appear in a single page of search results.
boolean	setSortOrder(java.util.Vector newSort) Deprecated. Sets the attribute names that define the sort order for the result set.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchCursor

public SearchCursor(java.util.Vector sort,
                    int blockSize,
                    boolean bSortingCr,
                    boolean bPagingCr)

Deprecated.

Constructs a SearchCursor object with a given sort order, block size (type int), and preferences regarding sorting and paging requirements.

Parameters:

sort - A Vector of attribute names that determine the sort order. A result set is sorted alphabetically by the first attribute in the Vector, and then the second, and so on.

blockSize - The maximum number of rows in a single page of search results.

bSortingCr - If true, the server should not return any result set unless it can be sorted.

bPagingCr - If true, the server should not return any result set unless it can be paginated.

SearchCursor

public SearchCursor(java.util.Vector sort,
                    long blockSize,
                    boolean bSortingCr,
                    boolean bPagingCr)

Deprecated.

Constructs a SearchCursor object with a given sort order, block size (type long), and preferences regarding sorting and paging requirements.

Parameters:

sort - A Vector of attribute names that determine the sort order. A result set is sorted alphabetically by the first attribute in the Vector, and then the second, and so on.

blockSize - The maximum number of rows in a single page of search results.

bSortingCr - If true, the server should not return any result set unless it can be sorted.

bPagingCr - If true, the server should not return any result set unless it can be paginated.

Method Detail

getSortOrder

public java.util.Vector getSortOrder()

Deprecated.

Retrieves the attribute names that define the sort order for the result set. Sort order is described in setSortOrder().

The sort order can't be changed once the cursor has been used.

Returns:

The sort order as a Vector of attribute names.

setSortOrder

public boolean setSortOrder(java.util.Vector newSort)

Deprecated.

Sets the attribute names that define the sort order for the result set. A result set is sorted alphabetically by the first attribute in the Vector, and then the second, and so on.

The sort order can't be changed once the cursor has been used.

Parameters:

newSort - The sort order as a Vector of attribute names.

Returns:

A boolean indicating whether the sort order was changed. Failure typically indicates that the cursor has been used and the sort order is locked.

lockSortOrder

public boolean lockSortOrder()

Deprecated.

Locks the sort order. This method is used internally to make sure that the sort order is not changed while a cursor is in use.

Returns:

A boolean indicating whether or not the sort order was locked. Failure indicates that the cursor was already locked.

getRowsPerPage

public long getRowsPerPage()

Deprecated.

Retrieves the maximum number of rows that can appear in a single page of search results.

Returns:

The maximum rows in a page of search results.

setRowsPerPage

public void setRowsPerPage(long size)

Deprecated.

Sets the maximum number of rows that can appear in a single page of search results.

Parameters:

size - The new maximum rows for a page of search results.

getOffset

public long getOffset()

Deprecated.

Retrieves the starting offset of the block to be returned from the result set. The offset is the row number from the beginning of the result set.

Returns:

The starting offset for the block to be returned.

setOffset

public void setOffset(long size)

Deprecated.

Sets the starting offset of the block to be returned from the result set. The offset is the row number from the beginning of the result set.

Parameters:

size - The new starting offset for the block to be returned.

isSortingCritical

public boolean isSortingCritical()

Deprecated.

Indicates whether it is critical to sort a result set. If this method returns true, a result set is returned only if it can be sorted.

Returns:

true if sorting is critical, false otherwise.

isPagingCritical

public boolean isPagingCritical()

Deprecated.

Indicates whether paging features are critical for a result set. If this method returns true, a result set is returned only if it can be paginated.

Returns:

true if paging is critical, false otherwise.

getProperties

public java.util.Hashtable getProperties()

Deprecated.

For internal use only.