OSID Logo
OSID Specifications
workflow package
Version 3.1.0
Interfaceosid.workflow.OfficeSearch
Implementsosid.OsidSearch
Used Byosid.workflow.OfficeSearchSession
Description

The search interface for governing office searches.

MethodsearchAmongOffices
Description

Execute this search among the given list of offices.

Parametersosid.id.IdListofficeIds list of offices
ErrorsNULL_ARGUMENT officeIds is null
Compliancemandatory This method must be implemented.
MethodorderOfficeResults
Description

Specify an ordering to the search results.

Parametersosid.workflow.OfficeSearchOrderofficeSearchOrder office search order
ErrorsNULL_ARGUMENT officeSearchOrder is null
UNSUPPORTED officeSearchOrder is not of this service
Compliancemandatory This 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.TypeofficeSearchRecordType an office search record type
Returnosid.workflow.records.OfficeSearchRecord the office search record
ErrorsNULL_ARGUMENT officeSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(officeSearchRecordType) is false
Compliancemandatory This method must be implemented.