Interface | osid.workflow.rules.StepProcessorLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. The methods | ||
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 | canLookupStepProcessors | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeStepProcessorView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryStepProcessorView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedOfficeView | ||
Description |
Federates the view for methods in this session. A federated view will include step processor in offices which are children of this office 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 | useActiveStepProcessorView | ||
Description |
Only active step processors are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusStepProcessorView | ||
Description |
All active and inactive step processors enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getStepProcessor | ||
Description |
Gets the In active mode, step processors are returned that are currently active. In any status mode, active and inactive step processors are returned. | ||
Parameters | osid.id.Id | stepProcessorId | Id of the StepProcessor |
Return | osid.workflow.rules.StepProcessor | the step processor | |
Errors | NOT_FOUND | stepProcessorId not found | |
NULL_ARGUMENT | stepProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getStepProcessorsByIds | ||
Description |
Gets a In active mode, step processors are returned that are currently active. In any status mode, active and inactive step processors are returned. | ||
Parameters | osid.id.IdList | stepProcessorIds | the list of Ids to retrieve |
Return | osid.workflow.rules.StepProcessorList | the returned StepProcessor list | |
Errors | NOT_FOUND | a Id was not found | |
NULL_ARGUMENT | stepProcessorIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessorsByGenusType | ||
Description |
Gets a In active mode, step processors are returned that are currently active. In any status mode, active and inactive step processors are returned. | ||
Parameters | osid.type.Type | stepProcessorGenusType | a step processor genus type |
Return | osid.workflow.rules.StepProcessorList | the returned StepProcessor list | |
Errors | NULL_ARGUMENT | stepProcessorGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessorsByParentGenusType | ||
Description |
Gets a In active mode, step processors are returned that are currently active. In any status mode, active and inactive step processors are returned. | ||
Parameters | osid.type.Type | stepProcessorGenusType | a step processor genus type |
Return | osid.workflow.rules.StepProcessorList | the returned StepProcessor list | |
Errors | NULL_ARGUMENT | stepProcessorGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessorsByRecordType | ||
Description |
Gets a In active mode, step processors are returned that are currently active. In any status mode, active and inactive step processors are returned. | ||
Parameters | osid.type.Type | stepProcessorRecordType | a step processor record type |
Return | osid.workflow.rules.StepProcessorList | the returned StepProcessor list | |
Errors | NULL_ARGUMENT | stepProcessorRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessors | ||
Description |
Gets all In plenary mode, the returned list contains all known step processor or an error results. Otherwise, the returned list may contain only those step processor that are accessible through this session. In active mode, step processors are returned that are currently active. In any status mode, active and inactive step processors are returned. | ||
Return | osid.workflow.rules.StepProcessorList | the returned StepProcessor list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |