OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.OfficeSearch
Implementsosid.OsidSearch
Description

The search interface for governing office searches.

MethodsearchAmongOffices
Description

Execute this search among the given list of offices.

Parametersosid.id.IdListofficeIdslist of offices
ErrorsNULL_ARGUMENT officeIds is null
CompliancemandatoryThis method must be implemented.
MethodorderOfficeResults
Description

Specify an ordering to the search results.

Parametersosid.workflow.OfficeSearchOrderofficeSearchOrderoffice search order
ErrorsNULL_ARGUMENT officeSearchOrder is null
UNSUPPORTED officeSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetOfficeSearchRecord
Description

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

Parametersosid.type.TypeofficeSearchRecordTypea office search record type
Returnosid.workflow.records.OfficeSearchRecordthe office search record
ErrorsNULL_ARGUMENT officeSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(officeSearchRecordType) is false
CompliancemandatoryThis method must be implemented.