Interface AuthorizationSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AuthorizationSearch
extends OsidSearch

AuthorizationSearch defines the interface for specifying authorization search options.

Method Summary

Modifier and Type	Method	Description
AuthorizationSearchRecord	getAuthorizationSearchRecord(Type authorizationSearchRecordType)	Gets the authorization search record corresponding to the given authorization search record Type .This method is used to retrieve an object implementing the requested record.
void	orderAuthorizationResults(AuthorizationSearchOrder authorizationSearchOrder)	Specify an ordering to the search results.
void	searchAmongAuthorizations(IdList authorizationIds)	Execute this search among the given list of authorizations.

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

searchAmongAuthorizations

void searchAmongAuthorizations(IdList authorizationIds)

Execute this search among the given list of authorizations.

Parameters:

authorizationIds - list of authorizations

Throws:

NullArgumentException - authorizationIds is null

Compliance:

mandatory - This method must be implemented.

orderAuthorizationResults

void orderAuthorizationResults(AuthorizationSearchOrder authorizationSearchOrder)

Specify an ordering to the search results.

Parameters:

authorizationSearchOrder - authorization search order

Throws:

NullArgumentException - authorizationSearchOrder is null

UnsupportedException - authorizationSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAuthorizationSearchRecord

AuthorizationSearchRecord getAuthorizationSearchRecord(Type authorizationSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

authorizationSearchRecordType - an authorization search record type

Returns:

the authorization search record

Throws:

NullArgumentException - authorizationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(authorizationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.