Interface | osid.workflow.rules.StepConstrainerSmartOfficeSession | ||
---|---|---|---|
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 | getStepConstrainerQuery | ||
Description |
Gets a step constrainer query. | ||
Return | osid.workflow.rules.StepConstrainerQuery | the step constrainer query | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepConstrainerSearchOrder | ||
Description |
Gets a step constrainer search order. | ||
Return | osid.workflow.rules.StepConstrainerSearchOrder | the step constrainer search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyStepConstrainerQuery | ||
Description |
Applies a step constrainer query to this office. | ||
Parameters | osid.workflow.rules.StepConstrainerQuery | stepConstrainerQuery | the step constrainer query |
Errors | NULL_ARGUMENT | stepConstrainerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | stepConstrainerQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectStepConstrainerQuery | ||
Description |
Gets a step constrainer query inspector for this office. | ||
Return | osid.workflow.rules.StepConstrainerQueryInspector | the step constrainer query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyStepConstrainerSequencing | ||
Description |
Applies a step constrainer search order to this office. | ||
Parameters | osid.workflow.rules.StepConstrainerSearchOrder | stepConstrainerSearchOrder | the step constrainer search order |
Errors | NULL_ARGUMENT | stepConstrainerSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | stepConstrainerSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepConstrainerQueryFromInspector | ||
Description |
Gets a step constrainer query from an inspector. | ||
Parameters | osid.workflow.rules.StepConstrainerQueryInspector | stepConstrainerQueryInspector | a step constrainer query inspector |
Return | osid.workflow.rules.StepConstrainerQuery | the step constrainer query | |
Errors | NULL_ARGUMENT | stepConstrainerQueryInspector is null | |
UNSUPPORTED | stepConstrainerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |