org.osid.workflow

Interface WorkflowEventLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface WorkflowEventLookupSession
extends OsidSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupWorkflowEvents() Tests if this user can look up workflow events.
Office	getOffice() Gets the Office associated with this session.
Id	getOfficeId() Gets the Office Id associated with this session.
WorkflowEvent	getWorkflowEvent(Id workflowEventId) Gets the WorkflowEvent specified by its Id.
WorkflowEventList	getWorkflowEvents() Gets the entire workflow log.
WorkflowEventList	getWorkflowEventsByDate(DateTime start, DateTime end) Gets the entire workflow log within the given date range inclusive.
WorkflowEventList	getWorkflowEventsByDateForProcess(Id processId, DateTime start, DateTime end) Gets the entire workflow log for this process within the given date range inclusive.
WorkflowEventList	getWorkflowEventsByDateForStep(Id stepId, DateTime start, DateTime end) Gets the workflow log for a step within the given date range inclusive.
WorkflowEventList	getWorkflowEventsByDateForStepAndWork(Id stepId, Id workId, DateTime start, DateTime end) Gets the workflow log for a work in this process within the given date range inclusive.
WorkflowEventList	getWorkflowEventsByDateForWork(Id workId, DateTime start, DateTime end) Gets the workflow log for a work within the given date range inclusive.
WorkflowEventList	getWorkflowEventsByDateForWorkAndProcess(Id processId, Id workId, DateTime start, DateTime end) Gets the workflow log for a work in a process within the given date range inclusive.
WorkflowEventList	getWorkflowEventsByDateForWorker(Id resourceId, DateTime start, DateTime end) Gets the workflow log by the resource in this process within the given date range inclusive.
WorkflowEventList	getWorkflowEventsByDateForWorkerAndProcess(Id resourceId, Id processId, DateTime start, DateTime end) Gets the workflow log by the resource in this process within the given date range inclusive.
WorkflowEventList	getWorkflowEventsByGenusType(Type workflowEventGenusType) 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.
WorkflowEventList	getWorkflowEventsByIds(IdList workflowEventIds) Gets a WorkflowEventList corresponding to the given IdList.
WorkflowEventList	getWorkflowEventsByParentGenusType(Type workflowEventGenusType) 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.
WorkflowEventList	getWorkflowEventsByRecordType(Type workflowEventRecordType) Gets a WorkflowEventList containing the given workflow event record Type.
WorkflowEventList	getWorkflowEventsForProcess(Id processId) Gets the entire workflow log for a process.
WorkflowEventList	getWorkflowEventsForStep(Id stepId) Gets the workflow log for a step.
WorkflowEventList	getWorkflowEventsForStepAndWork(Id stepId, Id workId) Gets the workflow log for a work in this process.
WorkflowEventList	getWorkflowEventsForWork(Id workId) Gets the workflow log for a work.
WorkflowEventList	getWorkflowEventsForWorkAndProcess(Id processId, Id workId) Gets the workflow log for a work in a process.
WorkflowEventList	getWorkflowEventsForWorker(Id resourceId) Gets the workflow log by an agent in this process.
WorkflowEventList	getWorkflowEventsForWorkerAndProcess(Id resourceId, Id processId) Gets the workflow log by an agent in this process.
void	useComparativeWorkflowEventView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedOfficeView() Federates the view for methods in this session.
void	useIsolatedOfficeView() Isolates the view for methods in this session.
void	usePlenaryWorkflowEventView() A complete view of the WorkflowEvent returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getOfficeId

Id getOfficeId()

Gets the Office Id associated with this session.

Returns:

the Office Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOffice

Office getOffice()
                 throws OperationFailedException,
                        PermissionDeniedException

Gets the Office associated with this session.

Returns:

the office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupWorkflowEvents

boolean canLookupWorkflowEvents()

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.

Returns:

false if workflow event lookups is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeWorkflowEventView

void useComparativeWorkflowEventView()

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.

usePlenaryWorkflowEventView

void usePlenaryWorkflowEventView()

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.

Compliance:

mandatory - This method is must be implemented.

useFederatedOfficeView

void useFederatedOfficeView()

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.

useIsolatedOfficeView

void useIsolatedOfficeView()

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.

getWorkflowEvent

WorkflowEvent getWorkflowEvent(Id workflowEventId)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

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.

Parameters:

workflowEventId - Id of the WorkflowEvent

Returns:

the workflow event

Throws:

NotFoundException - workflowEventId not found

NullArgumentException - workflowEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getWorkflowEventsByIds

WorkflowEventList getWorkflowEventsByIds(IdList workflowEventIds)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

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.

Parameters:

workflowEventIds - the list of Ids to retrieve

Returns:

the returned WorkflowEvent list

Throws:

NotFoundException - an Id was not found

NullArgumentException - workflowEventIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsByGenusType

WorkflowEventList getWorkflowEventsByGenusType(Type workflowEventGenusType)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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.

Parameters:

workflowEventGenusType - a workflow event genus type

Returns:

the returned WorkflowEvent list

Throws:

NullArgumentException - workflowEventGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsByParentGenusType

WorkflowEventList getWorkflowEventsByParentGenusType(Type workflowEventGenusType)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

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.

Parameters:

workflowEventGenusType - a workflow event genus type

Returns:

the returned WorkflowEvent list

Throws:

NullArgumentException - workflowEventGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsByRecordType

WorkflowEventList getWorkflowEventsByRecordType(Type workflowEventRecordType)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

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.

Parameters:

workflowEventRecordType - a workflow event record type

Returns:

the returned WorkflowEvent list

Throws:

NullArgumentException - workflowEventRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsByDate

WorkflowEventList getWorkflowEventsByDate(DateTime start,
                                        DateTime end)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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:

start - start range

end - end range

Returns:

the workflow events

Throws:

InvalidArgumentException - start is greater than end

NullArgumentException - start or end is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsForProcess

WorkflowEventList getWorkflowEventsForProcess(Id processId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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:

processId - a process Id

Returns:

the workflow events

Throws:

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsByDateForProcess

WorkflowEventList getWorkflowEventsByDateForProcess(Id processId,
                                                  DateTime start,
                                                  DateTime end)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

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:

processId - a process Id

start - start range

end - end range

Returns:

the workflow events

Throws:

InvalidArgumentException - start is greater than end

NullArgumentException - processId, start, or end is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsForStep

WorkflowEventList getWorkflowEventsForStep(Id stepId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

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:

stepId - a step Id

Returns:

the workflow events

Throws:

NullArgumentException - stepId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsByDateForStep

WorkflowEventList getWorkflowEventsByDateForStep(Id stepId,
                                               DateTime start,
                                               DateTime end)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

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:

stepId - a step Id

start - start range

end - end range

Returns:

the workflow events

Throws:

InvalidArgumentException - start is greater than end

NullArgumentException - stepId, start or end is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsForWork

WorkflowEventList getWorkflowEventsForWork(Id workId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

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:

workId - a work Id

Returns:

the workflow events

Throws:

NullArgumentException - workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsByDateForWork

WorkflowEventList getWorkflowEventsByDateForWork(Id workId,
                                               DateTime start,
                                               DateTime end)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

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:

workId - a work Id

start - start range

end - end range

Returns:

the workflow events

Throws:

InvalidArgumentException - start is greater than end

NullArgumentException - workId, start or end is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsForWorkAndProcess

WorkflowEventList getWorkflowEventsForWorkAndProcess(Id processId,
                                                   Id workId)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

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:

processId - a process Id

workId - a work Id

Returns:

the workflow events

Throws:

NullArgumentException - workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsByDateForWorkAndProcess

WorkflowEventList getWorkflowEventsByDateForWorkAndProcess(Id processId,
                                                         Id workId,
                                                         DateTime start,
                                                         DateTime end)
                                                           throws OperationFailedException,
                                                                  PermissionDeniedException

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:

processId - a process Id

workId - a work Id

start - start range

end - end range

Returns:

the workflow events

Throws:

InvalidArgumentException - start is greater than end

NullArgumentException - workId, start or end is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsForStepAndWork

WorkflowEventList getWorkflowEventsForStepAndWork(Id stepId,
                                                Id workId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

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:

stepId - a step Id

workId - a work Id

Returns:

the workflow events

Throws:

NullArgumentException - stepId or workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsByDateForStepAndWork

WorkflowEventList getWorkflowEventsByDateForStepAndWork(Id stepId,
                                                      Id workId,
                                                      DateTime start,
                                                      DateTime end)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

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:

stepId - a step Id

workId - a work Id

start - start range

end - end range

Returns:

the workflow events

Throws:

InvalidArgumentException - start is greater than end

NullArgumentException - stepId, workId, start or end is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsForWorker

WorkflowEventList getWorkflowEventsForWorker(Id resourceId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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:

resourceId - a resource Id

Returns:

the workflow events

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsByDateForWorker

WorkflowEventList getWorkflowEventsByDateForWorker(Id resourceId,
                                                 DateTime start,
                                                 DateTime end)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

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:

resourceId - a resource Id

start - start range

end - end range

Returns:

the workflow events

Throws:

InvalidArgumentException - start is greater than end

NullArgumentException - resourceId, start or end is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsForWorkerAndProcess

WorkflowEventList getWorkflowEventsForWorkerAndProcess(Id resourceId,
                                                     Id processId)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

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:

resourceId - a resource Id

processId - a process Id

Returns:

the workflow events

Throws:

NullArgumentException - resourceId or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEventsByDateForWorkerAndProcess

WorkflowEventList getWorkflowEventsByDateForWorkerAndProcess(Id resourceId,
                                                           Id processId,
                                                           DateTime start,
                                                           DateTime end)
                                                             throws OperationFailedException,
                                                                    PermissionDeniedException

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:

resourceId - a resource Id

processId - a process Id

start - start range

end - end range

Returns:

the workflow events

Throws:

InvalidArgumentException - start is greater than end

NullArgumentException - resourceId, processId, start or end is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkflowEvents

WorkflowEventList getWorkflowEvents()
                                    throws OperationFailedException,
                                           PermissionDeniedException

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.

Returns:

the workflow events

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.