Interface RegistrationRequestItemSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RegistrationRequestItemSearch
extends OsidSearch

The search interface for governing registration request item searches.

Method Summary

Modifier and Type	Method	Description
RegistrationRequestItemSearchRecord	getRegistrationRequestItemSearchRecord(Type registrationRequestItemSearchRecordType)	Gets the registration request item search record corresponding to the given registration request item search record Type.
void	orderRegistrationRequestItemResults(RegistrationRequestItemSearchOrder registrationRequestItemSearchOrder)	Specify an ordering to the search results.
void	searchAmongRegistrationRequestItems(IdList registrationRequestItemIds)	Execute this search among the given list of registration request items.

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

searchAmongRegistrationRequestItems

void searchAmongRegistrationRequestItems(IdList registrationRequestItemIds)

Execute this search among the given list of registration request items.

Parameters:

registrationRequestItemIds - list of registration request items

Throws:

NullArgumentException - registrationRequestItemIds is null

Compliance:

mandatory - This method must be implemented.

orderRegistrationRequestItemResults

void orderRegistrationRequestItemResults(RegistrationRequestItemSearchOrder registrationRequestItemSearchOrder)

Specify an ordering to the search results.

Parameters:

registrationRequestItemSearchOrder - registration request item search order

Throws:

NullArgumentException - registrationRequestItemSearchOrder is null

UnsupportedException - registrationRequestItemSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRegistrationRequestItemSearchRecord

RegistrationRequestItemSearchRecord getRegistrationRequestItemSearchRecord(Type registrationRequestItemSearchRecordType)
                                                                    throws OperationFailedException

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

Parameters:

registrationRequestItemSearchRecordType - a registration request item search record type

Returns:

the registration request item search record

Throws:

NullArgumentException - registrationRequestItemSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationRequestItemSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.