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

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

This session defines views that offer differing behaviors for searching.

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

Step processor enablers may have a query record indicated by their respective record types. The query record is accessed via the StepProcessorEnablerQuery.

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.
MethodcanSearchStepProcessorEnablers
Description

Tests if this user can perform StepProcessorEnabler 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 step processor enablers in offices which are children of this step in the office hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedOfficeView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetStepProcessorEnablerQuery
Description

Gets a step processor enabler query.

Returnosid.workflow.rules.StepProcessorEnablerQuerythe step processor enabler query
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorEnablersByQuery
Description

Gets a list of StepProcessorEnablers matching the given step processor enabler query.

Parametersosid.workflow.rules.StepProcessorEnablerQuerystepProcessorEnablerQuerythe step processor enabler query
Returnosid.workflow.rules.StepProcessorEnablerListthe returned StepProcessorEnablerList
ErrorsNULL_ARGUMENT stepProcessorEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED stepProcessorEnablerQuery is not of this service
CompliancemandatoryThis method must be implemented.