Interface AccountSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AccountSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getAccounts

AccountList getAccounts()

Gets the account list resulting from a search.

Returns:

the account list

Throws:

IllegalStateException - the account list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAccountQueryInspector

AccountQueryInspector getAccountQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getAccountSearchResultsRecord

AccountSearchResultsRecord getAccountSearchResultsRecord(Type accountSearchRecordType)
                                                  throws OperationFailedException

Gets the account search results record corresponding to the given account search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

accountSearchRecordType - an account search record type

Returns:

the account search results record

Throws:

NullArgumentException - accountSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(accountSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.