Interface | osid.workflow.rules.StepProcessorSmartOfficeSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic office. a This | ||
Method | getOfficeId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Office Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOffice | ||
Description |
Gets the | ||
Return | osid.workflow.Office | the office | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartOffices | ||
Description |
Tests if this user can manage smart office. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart office management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessorQuery | ||
Description |
Gets a step processor query. | ||
Return | osid.workflow.rules.StepProcessorQuery | the step processor query | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessorSearchOrder | ||
Description |
Gets a step processor search order. | ||
Return | osid.workflow.rules.StepProcessorSearchOrder | the step processor search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyStepProcessorQuery | ||
Description |
Applies a step processor query to this office. | ||
Parameters | osid.workflow.rules.StepProcessorQuery | stepProcessorQuery | the step processor query |
Errors | NULL_ARGUMENT | stepProcessorQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | stepProcessorQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectStepProcessorQuery | ||
Description |
Gets a step processor query inspector for this office. | ||
Return | osid.workflow.rules.StepProcessorQueryInspector | the step processor query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyStepProcessorSequencing | ||
Description |
Applies a step processor search order to this office. | ||
Parameters | osid.workflow.rules.StepProcessorSearchOrder | stepProcessorSearchOrder | the step processor search order |
Errors | NULL_ARGUMENT | stepProcessorSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | stepProcessorSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessorQueryFromInspector | ||
Description |
Gets a step processor query from an inspector. | ||
Parameters | osid.workflow.rules.StepProcessorQueryInspector | stepProcessorQueryInspector | a step processor query inspector |
Return | osid.workflow.rules.StepProcessorQuery | the step processor query | |
Errors | NULL_ARGUMENT | stepProcessorQueryInspector is null | |
UNSUPPORTED | stepProcessorQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |