Interface RegistrationRequestSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RegistrationRequestSearch
extends OsidSearch

The search interface for governing registration request searches.

Method Summary

Modifier and Type	Method	Description
RegistrationRequestSearchRecord	getRegistrationRequestSearchRecord(Type registrationRequestSearchRecordType)	Gets the registration request search record corresponding to the given registration request search record Type.
void	orderRegistrationRequestResults(RegistrationRequestSearchOrder registrationRequestSearchOrder)	Specify an ordering to the search results.
void	searchAmongRegistrationRequests(IdList registrationRequestIds)	Execute this search among the given list of registration requests.

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

searchAmongRegistrationRequests

void searchAmongRegistrationRequests(IdList registrationRequestIds)

Execute this search among the given list of registration requests.

Parameters:

registrationRequestIds - list of registration requests

Throws:

NullArgumentException - registrationRequestIds is null

Compliance:

mandatory - This method must be implemented.

orderRegistrationRequestResults

void orderRegistrationRequestResults(RegistrationRequestSearchOrder registrationRequestSearchOrder)

Specify an ordering to the search results.

Parameters:

registrationRequestSearchOrder - registration request search order

Throws:

NullArgumentException - registrationRequestSearchOrder is null

UnsupportedException - registrationRequestSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRegistrationRequestSearchRecord

RegistrationRequestSearchRecord getRegistrationRequestSearchRecord(Type registrationRequestSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

registrationRequestSearchRecordType - a registration request search record type

Returns:

the registration request search record

Throws:

NullArgumentException - registrationRequestSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationRequestSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.