OSID Logo
OSID Specifications
workflow package
Version 3.0.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.IdListofficeIdslist of offices
ErrorsNULL_ARGUMENTofficeIds is null
CompliancemandatoryThis method must be implemented.
MethodorderOfficeResults
Description

Specify an ordering to the search results.

Parametersosid.workflow.OfficeSearchOrderofficeSearchOrderoffice search order
ErrorsNULL_ARGUMENTofficeSearchOrder is null
UNSUPPORTEDofficeSearchOrder 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.TypeofficeSearchRecordTypean office search record type
Returnosid.workflow.records.OfficeSearchRecordthe office search record
ErrorsNULL_ARGUMENTofficeSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(officeSearchRecordType) is false
CompliancemandatoryThis method must be implemented.