Interface | osid.workflow.WorkflowEventLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
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 | canLookupWorkflowEvents | ||
Description |
Tests if this user can look up workflow events. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known changing a step sequence in a | ||
Return | boolean | false if workflow event lookups is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeWorkflowEventView | ||
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 | usePlenaryWorkflowEventView | ||
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 workflow events 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 | getWorkflowEvent | ||
Description |
Gets the | ||
Parameters | osid.id.Id | workflowEventId | Id of the WorkflowEvent |
Return | osid.workflow.WorkflowEvent | the workflow event | |
Errors | NOT_FOUND | workflowEventId not found | |
NULL_ARGUMENT | workflowEventId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getWorkflowEventsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | workflowEventIds | the list of Ids to retrieve |
Return | osid.workflow.WorkflowEventList | the returned WorkflowEvent list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | workflowEventIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | workflowEventGenusType | a workflow event genus type |
Return | osid.workflow.WorkflowEventList | the returned WorkflowEvent list | |
Errors | NULL_ARGUMENT | workflowEventGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | workflowEventGenusType | a workflow event genus type |
Return | osid.workflow.WorkflowEventList | the returned WorkflowEvent list | |
Errors | NULL_ARGUMENT | workflowEventGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | workflowEventRecordType | a workflow event record type |
Return | osid.workflow.WorkflowEventList | the returned WorkflowEvent list | |
Errors | NULL_ARGUMENT | workflowEventRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsByDate | ||
Description |
Gets the entire workflow log within the given date range inclusive. In plenary mode, the returned list contains all known workflow events or an error results. Otherwise, the returned list may contain only those workflow events that are accessible through this session. | ||
Parameters | osid.calendaring.DateTime | start | start range |
osid.calendaring.DateTime | end | end range | |
Return | osid.workflow.WorkflowEventList | the workflow events | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | start or end is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsForProcess | ||
Description |
Gets the entire workflow log for a process. In plenary mode, the returned list contains all known workflow events or an error results. Otherwise, the returned list may contain only those workflow events that are accessible through this session. | ||
Parameters | osid.id.Id | processId | a process Id |
Return | osid.workflow.WorkflowEventList | the workflow events | |
Errors | NULL_ARGUMENT | processId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsByDateForProcess | ||
Description |
Gets the entire workflow log for this process within the given date range inclusive. In plenary mode, the returned list contains all known workflow events or an error results. Otherwise, the returned list may contain only those workflow events that are accessible through this session. | ||
Parameters | osid.id.Id | processId | a process Id |
osid.calendaring.DateTime | start | start range | |
osid.calendaring.DateTime | end | end range | |
Return | osid.workflow.WorkflowEventList | the workflow events | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | processId, start, or end is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsForStep | ||
Description |
Gets the workflow log for a step. In plenary mode, the returned list contains all known workflow events or an error results. Otherwise, the returned list may contain only those workflow events that are accessible through this session. | ||
Parameters | osid.id.Id | stepId | a step Id |
Return | osid.workflow.WorkflowEventList | the workflow events | |
Errors | NULL_ARGUMENT | stepId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsByDateForStep | ||
Description |
Gets the workflow log for a step within the given date range inclusive. In plenary mode, the returned list contains all known workflow events or an error results. Otherwise, the returned list may contain only those workflow events that are accessible through this session. | ||
Parameters | osid.id.Id | stepId | a step Id |
osid.calendaring.DateTime | start | start range | |
osid.calendaring.DateTime | end | end range | |
Return | osid.workflow.WorkflowEventList | the workflow events | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | stepId, start or end is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsForWork | ||
Description |
Gets the workflow log for a work. In plenary mode, the returned list contains all known workflow events or an error results. Otherwise, the returned list may contain only those workflow events that are accessible through this session. | ||
Parameters | osid.id.Id | workId | a work Id |
Return | osid.workflow.WorkflowEventList | the workflow events | |
Errors | NULL_ARGUMENT | workId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsByDateForWork | ||
Description |
Gets the workflow log for a work within the given date range inclusive. In plenary mode, the returned list contains all known workflow events or an error results. Otherwise, the returned list may contain only those workflow events that are accessible through this session. | ||
Parameters | osid.id.Id | workId | a work Id |
osid.calendaring.DateTime | start | start range | |
osid.calendaring.DateTime | end | end range | |
Return | osid.workflow.WorkflowEventList | the workflow events | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | workId, start or end is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsForWorkAndProcess | ||
Description |
Gets the workflow log for a work in a process. In plenary mode, the returned list contains all known workflow events or an error results. Otherwise, the returned list may contain only those workflow events that are accessible through this session. | ||
Parameters | osid.id.Id | processId | a process Id |
osid.id.Id | workId | a work Id | |
Return | osid.workflow.WorkflowEventList | the workflow events | |
Errors | NULL_ARGUMENT | workId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsByDateForWorkAndProcess | ||
Description |
Gets the workflow log for a work in a process within the given date range inclusive. In plenary mode, the returned list contains all known workflow events or an error results. Otherwise, the returned list may contain only those workflow events that are accessible through this session. | ||
Parameters | osid.id.Id | processId | a process Id |
osid.id.Id | workId | a work Id | |
osid.calendaring.DateTime | start | start range | |
osid.calendaring.DateTime | end | end range | |
Return | osid.workflow.WorkflowEventList | the workflow events | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | workId, start or end is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsForStepAndWork | ||
Description |
Gets the workflow log for a work in this process. In plenary mode, the returned list contains all known workflow events or an error results. Otherwise, the returned list may contain only those workflow events that are accessible through this session. | ||
Parameters | osid.id.Id | stepId | a step Id |
osid.id.Id | workId | a work Id | |
Return | osid.workflow.WorkflowEventList | the workflow events | |
Errors | NULL_ARGUMENT | stepId or workId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsByDateForStepAndWork | ||
Description |
Gets the workflow log for a work in this process within the given date range inclusive. In plenary mode, the returned list contains all known workflow events or an error results. Otherwise, the returned list may contain only those workflow events that are accessible through this session. | ||
Parameters | osid.id.Id | stepId | a step Id |
osid.id.Id | workId | a work Id | |
osid.calendaring.DateTime | start | start range | |
osid.calendaring.DateTime | end | end range | |
Return | osid.workflow.WorkflowEventList | the workflow events | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | stepId, workId, start or end is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsForWorker | ||
Description |
Gets the workflow log by an agent in this process. In plenary mode, the returned list contains all known workflow events or an error results. Otherwise, the returned list may contain only those workflow events that are accessible through this session. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.workflow.WorkflowEventList | the workflow events | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsByDateForWorker | ||
Description |
Gets the workflow log by the resource in this process within the given date range inclusive. In plenary mode, the returned list contains all known workflow events or an error results. Otherwise, the returned list may contain only those workflow events that are accessible through this session. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.calendaring.DateTime | start | start range | |
osid.calendaring.DateTime | end | end range | |
Return | osid.workflow.WorkflowEventList | the workflow events | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | resourceId, start or end is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsForWorkerAndProcess | ||
Description |
Gets the workflow log by an agent in this process. In plenary mode, the returned list contains all known workflow events or an error results. Otherwise, the returned list may contain only those workflow events that are accessible through this session. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.id.Id | processId | a process Id | |
Return | osid.workflow.WorkflowEventList | the workflow events | |
Errors | NULL_ARGUMENT | resourceId or processId is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEventsByDateForWorkerAndProcess | ||
Description |
Gets the workflow log by the resource in this process within the given date range inclusive. In plenary mode, the returned list contains all known workflow events or an error results. Otherwise, the returned list may contain only those workflow events that are accessible through this session. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.id.Id | processId | a process Id | |
osid.calendaring.DateTime | start | start range | |
osid.calendaring.DateTime | end | end range | |
Return | osid.workflow.WorkflowEventList | the workflow events | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | resourceId, processId, start or end is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkflowEvents | ||
Description |
Gets the entire workflow log. In plenary mode, the returned list contains all known workflow events or an error results. Otherwise, the returned list may contain only those workflow events that are accessible through this session. | ||
Return | osid.workflow.WorkflowEventList | the workflow events | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |