Programming Guides › Programming Guide for Java › Delegated Management Services API › Cursor Class

Cursor Class

The SmDmsCursor class lets you define sorting and paging behavior for result set operations—for example:

• Set the sort parameter of the SmDmsCursor constructor to specify the columns to use for sorting rows.
• Call setBlockSize() to define the maximum number of rows that can be returned from a result set at one time—that is, the maximum number of rows in a page.
• Call setOffset() to specify the starting offset (row number) of the block returned from the result set.
• Call isSortingCritical() to specify whether a result set must be sorted.
  • If you specify true, a result set will be retrieved only if it can be sorted.
  • If you specify false, an unsorted result set will be sent if it cannot be sorted. An isSorted() call on the same SmDmsCursor object will return false.
• Call isPagingCritical() to specify whether a result set must be paginated.
  • If you specify true, a result set will be retrieved only if it can be paginated.
  • If you specify false, a complete result set will be sent if it cannot be sorted. An isPaginated() call on the same SmDmsCursor object will return false.

Searches that Support Cursor Operations

You can perform sorting and paging operations by passing a defined SmDmsCursor object into any of the following methods:

• One of the search methods in SmDmsOrganization:
  • search()
  • searchForward()
  • searchBack()
  • searchRefresh()
• SmDmsObject.getGroups()
• SmDmsOrganization.getGroups()
• SmDmsGroups.getMembers()

Note: getGroups() and getMembers() are not supported in searches of ODBC directories.

Searches of Microsoft LDAP Directories

Sorting and paging operations are not supported for Active Directories through the AD namespace. Sorting and paging operations are supported for Active Directories through the LDAP namespace.

When communicating with an Active Directory through the AD namespace, SiteMinder responds to sorting and paging requests as follows:

• If both isPagingCritical() and isSortingCritical() return false in the SmDmsCursor object, the result set is returned. No sorting and paging operations are performed.
• If either isPagingCritical() or isSortingCritical() returns true in the SmDmsCursor object, an error occurs. No result set is returned.

You specify whether sorting and paging operations are critical in the SmDmsCursor constructor.