Interface AuthorizationEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AuthorizationEnablerSearch
extends OsidSearch

The search interface for governing authorization enabler searches.

Method Summary

Modifier and Type	Method	Description
AuthorizationEnablerSearchRecord	getAuthorizationEnablerSearchRecord(Type authorizationEnablerSearchRecordType)	Gets the authorization enabler search record corresponding to the given authorization enabler search record Type .
void	orderAuthorizationEnablerResults(AuthorizationEnablerSearchOrder authorizationEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongAuthorizationEnablers(IdList authorizationEnablerIds)	Execute this search among the given list of authorization enablers.

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

searchAmongAuthorizationEnablers

void searchAmongAuthorizationEnablers(IdList authorizationEnablerIds)

Execute this search among the given list of authorization enablers.

Parameters:

authorizationEnablerIds - list of authorization enablers

Throws:

NullArgumentException - authorizationEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderAuthorizationEnablerResults

void orderAuthorizationEnablerResults(AuthorizationEnablerSearchOrder authorizationEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

authorizationEnablerSearchOrder - authorization enabler search order

Throws:

NullArgumentException - authorizationEnablerSearchOrder is null

UnsupportedException - authorizationEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAuthorizationEnablerSearchRecord

AuthorizationEnablerSearchRecord getAuthorizationEnablerSearchRecord(Type authorizationEnablerSearchRecordType)
                                                              throws OperationFailedException

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

Parameters:

authorizationEnablerSearchRecordType - an authorization enabler search record type

Returns:

the authorization enabler search record

Throws:

NullArgumentException - authorizationEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(authorizationEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.