public interface AccountSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
AccountQueryInspector |
getAccountQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
AccountList |
getAccounts()
Gets the account list resulting from a search.
|
AccountSearchResultsRecord |
getAccountSearchResultsRecord(Type accountSearchRecordType)
Gets the account search results record corresponding to the given
account search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
AccountList getAccounts()
IllegalStateException
- the account list has already
been retrievedmandatory
- This method must be implemented. AccountQueryInspector getAccountQueryInspector()
mandatory
- This method must be implemented. AccountSearchResultsRecord getAccountSearchResultsRecord(Type accountSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.accountSearchRecordType
- a account search record typeNullArgumentException
- accountSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(accountSearchRecordType)
is false
mandatory
- This method must be implemented.