OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.OfficeQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching among Office objects. 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
CompliancemandatoryThis method must be implemented.
MethodgetOfficeQuery
Description

Gets an office query.

Returnosid.workflow.OfficeQuerythe office query
CompliancemandatoryThis method must be implemented.
MethodgetOfficesByQuery
Description

Gets a list of Offices matching the given office query.

Parametersosid.workflow.OfficeQueryofficeQuerythe office query
Returnosid.workflow.OfficeListthe returned OfficeList
ErrorsNULL_ARGUMENT officeQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED officeQuery is not of this service
CompliancemandatoryThis method must be implemented.