Interface | osid.workflow.rules.ProcessEnablerSmartOfficeSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic offices. 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 offices. 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 | getProcessEnablerQuery | ||
Description |
Gets a process enabler query. | ||
Return | osid.workflow.rules.ProcessEnablerQuery | the process enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcessEnablerSearchOrder | ||
Description |
Gets a process enabler search order. | ||
Return | osid.workflow.rules.ProcessEnablerSearchOrder | the process enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyProcessEnablerQuery | ||
Description |
Applies a process enabler query to this office. | ||
Parameters | osid.workflow.rules.ProcessEnablerQuery | processEnablerQuery | the process enabler query |
Errors | NULL_ARGUMENT | processEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | processEnablerQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectProcessEnablerQuery | ||
Description |
Gets a process enabler query inspector for this office. | ||
Return | osid.workflow.rules.ProcessEnablerQueryInspector | the process enabler query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyProcessEnablerSequencing | ||
Description |
Applies a process enabler search order to this office. | ||
Parameters | osid.workflow.rules.ProcessEnablerSearchOrder | processEnablerSearchOrder | the process enabler search order |
Errors | NULL_ARGUMENT | processEnablerSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | processEnablerSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProcessEnablerQueryFromInspector | ||
Description |
Gets a process enabler query from an inspector. | ||
Parameters | osid.workflow.rules.ProcessEnablerQueryInspector | processEnablerQueryInspector | a process enabler query inspector |
Return | osid.workflow.rules.ProcessEnablerQuery | the process enabler query | |
Errors | NULL_ARGUMENT | processEnablerQueryInspector is null | |
UNSUPPORTED | processEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |