Interface | osid.workflow.ProcessLookupSession | ||
---|---|---|---|
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 | canLookupProcesses | ||
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 | useComparativeProcessView | ||
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 | usePlenaryProcessView | ||
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 processes 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 | useActiveProcessView | ||
Description |
Only active processes are returned from methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusProcessView | ||
Description |
Borth active and inactive processes are returned from methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getProcess | ||
Description |
Gets the In active mode, processes are returned that are currently active. In any status mode, active and inactive processes are returned. | ||
Parameters | osid.id.Id | processId | Id of the Process |
Return | osid.workflow.Process | the process | |
Errors | NOT_FOUND | processId not found | |
NULL_ARGUMENT | processId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getProcessesByIds | ||
Description |
Gets a In active mode, processes are returned that are currently active. In any status mode, active and inactive processes are returned. | ||
Parameters | osid.id.IdList | processIds | the list of Ids to retrieve |
Return | osid.workflow.ProcessList | the returned Process list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | processIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProcessesByGenusType | ||
Description |
Gets a In active mode, processes are returned that are currently active. In any status mode, active and inactive processes are returned. | ||
Parameters | osid.type.Type | processGenusType | a process genus type |
Return | osid.workflow.ProcessList | the returned Process list | |
Errors | NULL_ARGUMENT | processGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProcessesByParentGenusType | ||
Description |
Gets a In active mode, processes are returned that are currently active. In any status mode, active and inactive processes are returned. | ||
Parameters | osid.type.Type | processGenusType | a process genus type |
Return | osid.workflow.ProcessList | the returned Process list | |
Errors | NULL_ARGUMENT | processGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProcessesByRecordType | ||
Description |
Gets a In active mode, processes are returned that are currently active. In any status mode, active and inactive processes are returned. | ||
Parameters | osid.type.Type | processRecordType | a process record type |
Return | osid.workflow.ProcessList | the returned Process list | |
Errors | NULL_ARGUMENT | processRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProcessesByProvider | ||
Description |
Gets a In active mode, processes are returned that are currently active. In any status mode, active and inactive processes are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.workflow.ProcessList | the returned Process 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 | getProcesses | ||
Description |
Gets all In plenary mode, the returned list contains all known processes or an error results. Otherwise, the returned list may contain only those process that are accessible through this session. In active mode, processes are returned that are currently active. In any status mode, active and inactive processes are returned. | ||
Return | osid.workflow.ProcessList | a list of Processes | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |