OSID Logo
OSID Specifications
workflow package
Version 3.1.0
Interfaceosid.workflow.OfficeQuerySession
Implementsosid.OsidSession
Implemented Byosid.workflow.OfficeSearchSession
Used Byosid.workflow.WorkflowManager
osid.workflow.WorkflowProxyManager
Description

This session provides methods for searching among Offices. The search query is constructed using the OfficeQuery.

Offices may have a query record indicated by their respective record types. The query record is accessed via the OfficeQuery.

MethodcanSearchOffices
Description

Tests if this user can perform Office searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodgetOfficeQuery
Description

Gets an office query.

Returnosid.workflow.OfficeQuery the office query
Compliancemandatory This method must be implemented.
MethodgetOfficesByQuery
Description

Gets a list of Offices matching the given office query.

Parametersosid.workflow.OfficeQueryofficeQuery the office query
Returnosid.workflow.OfficeList the returned OfficeList
ErrorsNULL_ARGUMENT officeQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED officeQuery is not of this service
Compliancemandatory This method must be implemented.