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

This session provides methods for searching among Work objects. The search query is constructed using the WorkQuery.

This session defines views that offer differing behaviors for searching.

  • federated office view: searches include works in offices of which this office is an ancestor in the office hierarchy
  • isolated office view: searches are restricted to works in this office

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

MethodgetOfficeId
Description

Gets the Office Id associated with this session.

Returnosid.id.Idthe Office Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOffice
Description

Gets the Office associated with this session.

Returnosid.workflow.Officethe office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchWorks
Description

Tests if this user can perform Work lookups. 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.
MethoduseFederatedOfficeView
Description

Federates the view for methods in this session. A federated view will include works in offices which are children of this office in the office hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedOfficeView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this office only.

CompliancemandatoryThis method is must be implemented.
MethodgetWorkQuery
Description

Gets a work query.

Returnosid.workflow.WorkQuerythe work query
CompliancemandatoryThis method must be implemented.
MethodgetWorksByQuery
Description

Gets a list of Works matching the given work query.

Parametersosid.workflow.WorkQueryworkQuerythe work query
Returnosid.workflow.WorkListthe returned WorkList
ErrorsNULL_ARGUMENT workQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED workQuery is not of this service
CompliancemandatoryThis method must be implemented.