Interface | osid.workflow.StepSmartOfficeSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. 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 | getStepQuery | ||
Description |
Gets a step query. | ||
Return | osid.workflow.StepQuery | the step query | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepSearchOrder | ||
Description |
Gets a step search order. | ||
Return | osid.workflow.StepSearchOrder | the step search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyStepQuery | ||
Description |
Applies a step query to this office. | ||
Parameters | osid.workflow.StepQuery | stepQuery | the step query |
Errors | NULL_ARGUMENT | stepQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | stepQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectStepQuery | ||
Description |
Gets a step query inspector for this office. | ||
Return | osid.workflow.StepQueryInspector | the step query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyStepSequencing | ||
Description |
Applies a step search order to this office. | ||
Parameters | osid.workflow.StepSearchOrder | stepSearchOrder | the step search order |
Errors | NULL_ARGUMENT | stepSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | stepSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepQueryFromInspector | ||
Description |
Gets a step query from an inspector. | ||
Parameters | osid.workflow.StepQueryInspector | stepQueryInspector | a step query inspector |
Return | osid.workflow.StepQuery | the step query | |
Errors | NULL_ARGUMENT | stepQueryInspector is null | |
UNSUPPORTED | stepQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |