Interface AccountSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AccountSearch
extends OsidSearch

The search interface for governing account searches.

Method Summary

Modifier and Type	Method	Description
AccountSearchRecord	getAccountSearchRecord(Type accountSearchRecordType)	Gets the account search record corresponding to the given account search record Type.
void	orderAccountResults(AccountSearchOrder accountSearchOrder)	Specify an ordering to the search results.
void	searchAmongAccounts(IdList accountIds)	Execute this search among the given list of accounts.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongAccounts

void searchAmongAccounts(IdList accountIds)

Execute this search among the given list of accounts.

Parameters:

accountIds - list of accounts

Throws:

NullArgumentException - accountIds is null

Compliance:

mandatory - This method must be implemented.

orderAccountResults

void orderAccountResults(AccountSearchOrder accountSearchOrder)

Specify an ordering to the search results.

Parameters:

accountSearchOrder - account search order

Throws:

NullArgumentException - accountSearchOrder is null

UnsupportedException - accountSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAccountSearchRecord

AccountSearchRecord getAccountSearchRecord(Type accountSearchRecordType)
                                    throws OperationFailedException

Gets the account search 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 record

Throws:

NullArgumentException - accountSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(accountSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.