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

The search interface for governing activity unit searches.

MethodsearchAmongActivityUnits
Description

Execute this search among the given list of activity units.

Parametersosid.id.IdListactivityUnitIdslist of activity units
ErrorsNULL_ARGUMENT activityUnitIds is null
CompliancemandatoryThis method must be implemented.
MethodorderActivityUnitResults
Description

Specify an ordering to the search results.

Parametersosid.course.ActivityUnitSearchOrderactivityUnitSearchOrderactivity unit search order
ErrorsNULL_ARGUMENT activityUnitSearchOrder is null
UNSUPPORTED activityUnitSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetActivityUnitSearchRecord
Description

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

Parametersosid.type.TypeactivityUnitSearchRecordTypea activity unit search record type
Returnosid.course.records.ActivityUnitSearchRecordthe activity unit search record
ErrorsNULL_ARGUMENT activityUnitSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activityUnitSearchRecordType) is false
CompliancemandatoryThis method must be implemented.