Interface ActivityRegistrationSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ActivityRegistrationSearch
extends OsidSearch

The search interface for governing activity registration searches.

Method Summary

Modifier and Type	Method	Description
ActivityRegistrationSearchRecord	getActivityRegistrationSearchRecord(Type activityRegistrationSearchRecordType)	Gets the activity registration search record corresponding to the given activity registration search record Type .
void	orderActivityRegistrationResults(ActivityRegistrationSearchOrder activityRegistrationSearchOrder)	Specify an ordering to the search results.
void	searchAmongActivityRegistrations(IdList activityRegistrationIds)	Execute this search among the given list of activity registrations.

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

searchAmongActivityRegistrations

void searchAmongActivityRegistrations(IdList activityRegistrationIds)

Execute this search among the given list of activity registrations.

Parameters:

activityRegistrationIds - list of activity registrations

Throws:

NullArgumentException - activityRegistrationIds is null

Compliance:

mandatory - This method must be implemented.

orderActivityRegistrationResults

void orderActivityRegistrationResults(ActivityRegistrationSearchOrder activityRegistrationSearchOrder)

Specify an ordering to the search results.

Parameters:

activityRegistrationSearchOrder - activity registration search order

Throws:

NullArgumentException - activityRegistrationSearchOrder is null

UnsupportedException - activityRegistrationSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getActivityRegistrationSearchRecord

ActivityRegistrationSearchRecord getActivityRegistrationSearchRecord(Type activityRegistrationSearchRecordType)
                                                              throws OperationFailedException

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

Parameters:

activityRegistrationSearchRecordType - an activity registration search record type

Returns:

the activity registration search record

Throws:

NullArgumentException - activityRegistrationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityRegistrationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.