OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.WorkflowEventLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving WorkflowEvents.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated office view: All workflow event methods in this session operate, retrieve and pertain to workflow events defined explicitly in the current office.
  • federated office view: All workflow event methods in this session operate, retrieve and pertain to all workflow events defined in this office and any other wokflow events implicitly available in this office through office inheritence.
MethodgetOfficeId
Description

Gets the Office Id associated with this session.

Returnosid.id.Idthe Office Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOffice
Description

Gets the Office associated with this session.

Returnosid.workflow.Officethe office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupWorkflowEvents
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to an unauthorized user.

Returnboolean false if workflow event lookups is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeWorkflowEventView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryWorkflowEventView
Description

A complete view of the WorkflowEvent returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedOfficeView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedOfficeView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this office only.

CompliancemandatoryThis method is must be implemented.
MethodgetWorkflowEvent
Description

Gets the WorkflowEvent specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned WorkflowEvent may have a different Id than requested, such as the case where a duplicate Id was assigned to a WorkflowEvent and retained for compatibility.

Parametersosid.id.IdworkflowEventId Id of the WorkflowEvent
Returnosid.workflow.WorkflowEventthe workflow event
ErrorsNOT_FOUND workflowEventId not found
NULL_ARGUMENT workflowEventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetWorkflowEventsByIds
Description

Gets a WorkflowEventList corresponding to the given IdList. In plenary mode, the returned list contains all of the workflow events specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible WorkflowEvents may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListworkflowEventIdsthe list of Ids to retrieve
Returnosid.workflow.WorkflowEventListthe returned WorkflowEvent list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT workflowEventIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsByGenusType
Description

Gets a WorkflowEventList corresponding to the given workflow event genus Type which does not include workflow events of genus types derived from the specified Type. 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.

Parametersosid.type.TypeworkflowEventGenusTypea workflow event genus type
Returnosid.workflow.WorkflowEventListthe returned WorkflowEvent list
ErrorsNULL_ARGUMENT workflowEventGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsByParentGenusType
Description

Gets a WorkflowEventList corresponding to the given workflow event genus Type and include any additional workflow events with genus types derived from the specified Type. 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.

Parametersosid.type.TypeworkflowEventGenusTypea workflow event genus type
Returnosid.workflow.WorkflowEventListthe returned WorkflowEvent list
ErrorsNULL_ARGUMENT workflowEventGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsByRecordType
Description

Gets a WorkflowEventList containing the given workflow event record Type. 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.

Parametersosid.type.TypeworkflowEventRecordTypea workflow event record type
Returnosid.workflow.WorkflowEventListthe returned WorkflowEvent list
ErrorsNULL_ARGUMENT workflowEventRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsByDate
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.

Parametersosid.calendaring.DateTimestartstart range
osid.calendaring.DateTimeendend range
Returnosid.workflow.WorkflowEventListthe workflow events
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT start or end is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsForProcess
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.

Parametersosid.id.IdprocessIda process Id
Returnosid.workflow.WorkflowEventListthe workflow events
ErrorsNULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsByDateForProcess
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.

Parametersosid.id.IdprocessIda process Id
osid.calendaring.DateTimestartstart range
osid.calendaring.DateTimeendend range
Returnosid.workflow.WorkflowEventListthe workflow events
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT processId, start, or end is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsForStep
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.

Parametersosid.id.IdstepIda step Id
Returnosid.workflow.WorkflowEventListthe workflow events
ErrorsNULL_ARGUMENT stepId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsByDateForStep
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.

Parametersosid.id.IdstepIda step Id
osid.calendaring.DateTimestartstart range
osid.calendaring.DateTimeendend range
Returnosid.workflow.WorkflowEventListthe workflow events
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT stepId, start or end is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsForWork
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.

Parametersosid.id.IdworkIda work Id
Returnosid.workflow.WorkflowEventListthe workflow events
ErrorsNULL_ARGUMENT workId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsByDateForWork
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.

Parametersosid.id.IdworkIda work Id
osid.calendaring.DateTimestartstart range
osid.calendaring.DateTimeendend range
Returnosid.workflow.WorkflowEventListthe workflow events
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT workId, start or end is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsForWorkAndProcess
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.

Parametersosid.id.IdprocessIda process Id
osid.id.IdworkIda work Id
Returnosid.workflow.WorkflowEventListthe workflow events
ErrorsNULL_ARGUMENT workId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsByDateForWorkAndProcess
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.

Parametersosid.id.IdprocessIda process Id
osid.id.IdworkIda work Id
osid.calendaring.DateTimestartstart range
osid.calendaring.DateTimeendend range
Returnosid.workflow.WorkflowEventListthe workflow events
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT workId, start or end is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsForStepAndWork
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.

Parametersosid.id.IdstepIda step Id
osid.id.IdworkIda work Id
Returnosid.workflow.WorkflowEventListthe workflow events
ErrorsNULL_ARGUMENT stepId or workId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsByDateForStepAndWork
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.

Parametersosid.id.IdstepIda step Id
osid.id.IdworkIda work Id
osid.calendaring.DateTimestartstart range
osid.calendaring.DateTimeendend range
Returnosid.workflow.WorkflowEventListthe workflow events
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT stepId, workId, start or end is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsForWorker
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.

Parametersosid.id.IdresourceIda resource Id
Returnosid.workflow.WorkflowEventListthe workflow events
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsByDateForWorker
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.

Parametersosid.id.IdresourceIda resource Id
osid.calendaring.DateTimestartstart range
osid.calendaring.DateTimeendend range
Returnosid.workflow.WorkflowEventListthe workflow events
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT resourceId, start or end is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsForWorkerAndProcess
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.

Parametersosid.id.IdresourceIda resource Id
osid.id.IdprocessIda process Id
Returnosid.workflow.WorkflowEventListthe workflow events
ErrorsNULL_ARGUMENT resourceId or processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventsByDateForWorkerAndProcess
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.

Parametersosid.id.IdresourceIda resource Id
osid.id.IdprocessIda process Id
osid.calendaring.DateTimestartstart range
osid.calendaring.DateTimeendend range
Returnosid.workflow.WorkflowEventListthe workflow events
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT resourceId, processId, start or end is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEvents
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.

Returnosid.workflow.WorkflowEventListthe workflow events
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.