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

Interface	osid.workflow.event.WorkflowEventQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.workflow.event.WorkflowEventSearchSession`
Used By	`osid.workflow.event.WorkflowEventManager`
Used By	`osid.workflow.event.WorkflowEventProxyManager`
Description	This session provides methods for searching among `WorkflowEvents` . The search query is constructed using the `WorkflowEventQuery` . This session defines views that offer differing behaviors for searching. federated office view: searches include workflow events in offices of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to workflow events in this office Workflow Events may have a query record indicated by their respective record types. The query record is accessed via the `WorkflowEventQuery` .
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	canSearchWorkflowEvents
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 not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method 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 searches to this office only.
Compliance	`mandatory`		This method is must be implemented.
Method	getWorkflowEventQuery
Description	Gets a workflow event query.
Return	`osid.workflow.event.WorkflowEventQuery`		the workflow event query
Compliance	`mandatory`		This method must be implemented.
Method	getWorkflowEventsByQuery
Description	Gets a list of `WorkflowEvents` matching the given search.
Parameters	`osid.workflow.event.WorkflowEventQuery`	`workflowEventQuery`	the workflow event query
Return	`osid.workflow.event.WorkflowEventList`		the returned `WorkflowEventList`
Errors	NULL_ARGUMENT		`workflowEventQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`workflowEventQuery` did not originate from `getWorkflowEventQuery()`
Compliance	`mandatory`		This method must be implemented.