Interface | osid.workflow.rules.StepProcessorEnablerQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Step processor enablers may have a query record indicated
by their respective record types. The query record is accessed
via the | ||
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 | canSearchStepProcessorEnablers | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedOfficeView | ||
Description |
Federates the view for methods in this session. A federated view will include step processor enablers in offices which are children of this step in the office hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedOfficeView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this office only. | ||
Compliance | mandatory | This method is 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 | getStepProcessorEnablersByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.workflow.rules.StepProcessorEnablerQuery | stepProcessorEnablerQuery | the step processor enabler query |
Return | osid.workflow.rules.StepProcessorEnablerList | the returned StepProcessorEnablerList | |
Errors | NULL_ARGUMENT | stepProcessorEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | stepProcessorEnablerQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |