OSID Logo
OSID Specifications
course registration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.registration.ActivityRegistrationSearch
Implementsosid.OsidSearch
Description

The search interface for governing activity registration searches.

MethodsearchAmongActivityRegistrations
Description

Execute this search among the given list of activity registrations.

Parametersosid.id.IdListactivityRegistrationIdslist of activity registrations
ErrorsNULL_ARGUMENT activityRegistrationIds is null
CompliancemandatoryThis method must be implemented.
MethodorderActivityRegistrationResults
Description

Specify an ordering to the search results.

Parametersosid.course.registration.ActivityRegistrationSearchOrderactivityRegistrationSearchOrderactivity registration search order
ErrorsNULL_ARGUMENT activityRegistrationSearchOrder is null
UNSUPPORTED activityRegistrationSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationSearchRecord
Description

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.

Parametersosid.type.TypeactivityRegistrationSearchRecordTypea activity registration search record type
Returnosid.course.registration.records.ActivityRegistrationSearchRecordthe activity registration search record
ErrorsNULL_ARGUMENT activityRegistrationSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activityRegistrationSearchRecordType) is false
CompliancemandatoryThis method must be implemented.