OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ActivitySearch
Implementsosid.OsidSearch
Description

ActivitySearch defines the interface for specifying activity search options.

MethodsearchAmongActivities
Description

Execute this search among the given list of activities.

Parametersosid.id.IdListactivityIdslist of activities
ErrorsNULL_ARGUMENT activityIds is null
CompliancemandatoryThis method must be implemented.
MethodorderActivityResults
Description

Specify an ordering to the search results.

Parametersosid.learning.ActivitySearchOrderactivitiesearchOrderactivity search order
ErrorsNULL_ARGUMENT activitiesearchOrder is null
UNSUPPORTED activitiesearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetActivitySearchRecord
Description

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

Parametersosid.type.TypeactivitiesearchRecordTypean activity search record type
Returnosid.learning.records.ActivitySearchRecordthe activity search record
ErrorsNULL_ARGUMENT activitiesearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasSearchRecordType(activitiesearchRecordType) is false
CompliancemandatoryThis method must be implemented.