OSID - osid.workflow.event.WorkflowEventLookupSession Service Interface Definition

Interface	osid.workflow.event.WorkflowEventLookupSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.event.WorkflowEventManager`
Used By	`osid.workflow.event.WorkflowEventProxyManager`
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 Using an isolated view is useful for managing `WorkflowEvents` with the `WorkflowEventAdminSession` . federated workflow event view: All workflow event methods in this session operate, retrieve and pertain to all workflow events defined in this office and any other workflow events implicitly available in this office through office inheritence. 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 `useFederatedOfficeView()` and `useIsolatedOfficeView() behave` as a radio group and one should be selected before invoking any lookup methods.
Method	getOfficeId
Description	Gets the `Office` `Id` associated with this session.
Return	`osid.id.Id`		the `Office Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOffice
Description	Gets the `Office` associated with this session.
Return	`osid.workflow.Office`		the office
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupWorkflowEvents
Description	Tests if this user can perform `WorkflowEvent` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED` .This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are 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 `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.
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 `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	`osid.id.Id`	`workflowEventId`	`Id` of the `WorkflowEvent`
Return	`osid.workflow.event.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 `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	`osid.id.IdList`	`workflowEventIds`	the list of `Ids` to retrieve
Return	`osid.workflow.event.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 `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	`osid.type.Type`	`workflowEventGenusType`	a workflow event genus type
Return	`osid.workflow.event.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 `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	`osid.type.Type`	`workflowEventGenusType`	a workflow event genus type
Return	`osid.workflow.event.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 `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	`osid.type.Type`	`workflowEventRecordType`	a workflow event record type
Return	`osid.workflow.event.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
Parameters	`osid.calendaring.DateTime`	`end`	end range
Return	`osid.workflow.event.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.event.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.event.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.event.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.event.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.event.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.event.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`
Parameters	`osid.id.Id`	`workId`	a work `Id`
Return	`osid.workflow.event.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.event.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`
Parameters	`osid.id.Id`	`workId`	a work `Id`
Return	`osid.workflow.event.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.event.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.event.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.event.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`
Parameters	`osid.id.Id`	`processId`	a process `Id`
Return	`osid.workflow.event.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.event.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 all `WorkflowEvents` . 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.event.WorkflowEventList`		a list of `WorkflowEvents`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.