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

The search interface for governing activity searches.

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.financials.ActivitySearchOrderactivitySearchOrderactivity search order
ErrorsNULL_ARGUMENT activitySearchOrder is null
UNSUPPORTED activitySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetActivitySearchRecord
Description

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

Parametersosid.type.TypeactivitySearchRecordTypea activity search record type
Returnosid.financials.records.ActivitySearchRecordthe activity search record
ErrorsNULL_ARGUMENT activitySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activitySearchRecordType) is false
CompliancemandatoryThis method must be implemented.