Interface | osid.workflow.StepLookupSession | ||
---|---|---|---|
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 | canLookupSteps | ||
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 | useComparativeStepView | ||
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 | usePlenaryStepView | ||
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 steps 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 | useActiveStepView | ||
Description |
Only active steps are returned from methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusStepView | ||
Description |
Borth active and inactive steps are returned from methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getStep | ||
Description |
Gets the In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned. | ||
Parameters | osid.id.Id | stepId | Id of the Step |
Return | osid.workflow.Step | the step | |
Errors | NOT_FOUND | stepId not found | |
NULL_ARGUMENT | stepId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getStepsByIds | ||
Description |
Gets a In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned. | ||
Parameters | osid.id.IdList | stepIds | the list of Ids to retrieve |
Return | osid.workflow.StepList | the returned Step list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | stepIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepsByGenusType | ||
Description |
Gets a In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned. | ||
Parameters | osid.type.Type | stepGenusType | a step genus type |
Return | osid.workflow.StepList | the returned Step list | |
Errors | NULL_ARGUMENT | stepGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepsByParentGenusType | ||
Description |
Gets a In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned. | ||
Parameters | osid.type.Type | stepGenusType | a step genus type |
Return | osid.workflow.StepList | the returned Step list | |
Errors | NULL_ARGUMENT | stepGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepsByRecordType | ||
Description |
Gets a In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned. | ||
Parameters | osid.type.Type | stepRecordType | a step record type |
Return | osid.workflow.StepList | the returned Step list | |
Errors | NULL_ARGUMENT | stepRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepsByProvider | ||
Description |
Gets a In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.workflow.StepList | the returned Step list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepsForProcess | ||
Description |
Gets a list of steps by process. In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned. | ||
Parameters | osid.id.Id | processId | a process Id |
Return | osid.workflow.StepList | the returned Step list | |
Errors | NULL_ARGUMENT | processId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepsByState | ||
Description |
Gets a list of steps for which the given state is
valid. The steps returned are the states specified in the
previous step or the process. In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned. | ||
Parameters | osid.id.Id | stateId | a stateId Id |
Return | osid.workflow.StepList | the returned Step list | |
Errors | NULL_ARGUMENT | stateId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSteps | ||
Description |
Gets all In plenary mode, the returned list contains all known steps or an error results. Otherwise, the returned list may contain only those steps that are accessible through this session. In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned. | ||
Return | osid.workflow.StepList | a list of Steps | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |