Interface | osid.workflow.rules.StepProcessorEnablerSmartOfficeSession | ||
---|---|---|---|
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 | getStepProcessorEnablerQuery | ||
Description |
Gets a step processor enabler query. | ||
Return | osid.workflow.rules.StepProcessorEnablerQuery | the step processor enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessorEnablerSearchOrder | ||
Description |
Gets a step processor enabler search order. | ||
Return | osid.workflow.rules.StepProcessorEnablerSearchOrder | the step processor enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyStepProcessorEnablerQuery | ||
Description |
Applies a step processor enabler query to this office. | ||
Parameters | osid.workflow.rules.StepProcessorEnablerQuery | stepProcessorEnablerQuery | the step processor enabler query |
Errors | NULL_ARGUMENT | stepProcessorEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | stepProcessorEnablerQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectStepProcessorEnablerQuery | ||
Description |
Gets a step processor enabler query inspector for this office. | ||
Return | osid.workflow.rules.StepProcessorEnablerQueryInspector | the step processor enabler query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyStepProcessorEnablerSequencing | ||
Description |
Applies a step processor enabler search order to this office. | ||
Parameters | osid.workflow.rules.StepProcessorEnablerSearchOrder | stepProcessorEnablerSearchOrder | the step processor enabler search order |
Errors | NULL_ARGUMENT | stepProcessorEnablerSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | stepProcessorEnablerSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessorEnablerQueryFromInspector | ||
Description |
Gets a step processor enabler query from an inspector. | ||
Parameters | osid.workflow.rules.StepProcessorEnablerQueryInspector | stepProcessorEnablerQueryInspector | a step processor enabler query inspector |
Return | osid.workflow.rules.StepProcessorEnablerQuery | the step processor enabler query | |
Errors | NULL_ARGUMENT | stepProcessorEnablerQueryInspector is null | |
UNSUPPORTED | stepProcessorEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |