public class SearchResults extends Object
Modifier and Type | Field and Description |
---|---|
static String |
VLVRESPONSE_CONTENT_COUNT
Attribute name used with Object get( String ).
|
static String |
VLVRESPONSE_CONTEXT
Attribute name used with Object get( String ).
|
static String |
VLVRESPONSE_FIRST_POSITION
Attribute name used with Object get( String ).
|
static String |
VLVRESPONSE_RESULT_CODE
Attribute name used with Object get( String ).
|
Modifier and Type | Method and Description |
---|---|
void |
abandon()
Abandons a current search operation, notifying the server not to send
additional search results.
|
PersistentObject |
assertOneEntry()
Assert if the search result contains one and only one entry.
|
Object |
get(String name)
Get search result attributes related to the search operation performed.
|
boolean |
hasMoreElements()
Checks whether there are entries available.
|
PersistentObject |
next()
Returns the next entry in the search results.
|
public static final String VLVRESPONSE_CONTENT_COUNT
public static final String VLVRESPONSE_FIRST_POSITION
public static final String VLVRESPONSE_RESULT_CODE
public static final String VLVRESPONSE_CONTEXT
public boolean hasMoreElements()
true
if there is more to readpublic PersistentObject next() throws UMSException
UMSException
- No more entries in the search results.public PersistentObject assertOneEntry() throws EntryNotFoundException, UMSException
EntryNotFoundException
- if there is no entry at allUMSException
public Object get(String name) throws UMSException
name
- Name of attribute to return, null if attribute is unknown or
not foundUMSException
- from accessor methods on LDAPVirtualListResponse controlpublic void abandon() throws UMSException
UMSException
- from abandoning a search operation from LDAPCopyright © 2010-2016, ForgeRock All Rights Reserved.