public interface RegistrationSearch extends OsidSearch
The search interface for governing registration searches.
Modifier and Type | Method and Description |
---|---|
RegistrationSearchRecord |
getRegistrationSearchRecord(Type registrationSearchRecordType)
Gets the registration search record corresponding to the given
registration search record
Type. |
void |
orderRegistrationResults(RegistrationSearchOrder registrationSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongRegistrations(IdList registrationIds)
Execute this search among the given list of registrations.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongRegistrations(IdList registrationIds)
registrationIds
- list of coursesNullArgumentException
- registrationIds
is null
mandatory
- This method must be implemented. void orderRegistrationResults(RegistrationSearchOrder registrationSearchOrder)
registrationSearchOrder
- course search orderNullArgumentException
- registrationSearchOrder
is null
UnsupportedException
- registrationSearchOrder
is not of this servicemandatory
- This method must be implemented. RegistrationSearchRecord getRegistrationSearchRecord(Type registrationSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.registrationSearchRecordType
- a course search record typeNullArgumentException
-
registrationSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(registrationSearchRecordType)
is
false
mandatory
- This method must be implemented.