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

Interface	osid.workflow.event.WorkflowEventSearchSession
Implements	`osid.workflow.event.WorkflowEventQuerySession`
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` . `getWorkflowEventsByQuery()` is the basic search method and returns a list of `WorkflowEvents` . A more advanced search may be performed with `getWorkflowEventsBySearch()` .It accepts a `WorkflowEventSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getWorkflowEventsBySearch()` returns a `WorkflowEventSearchResults` that can be used to access the resulting `WorkflowEventList` or be used to perform a search within the result set through `WorkflowEventSearch` . 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	getWorkflowEventSearch
Description	Gets a workflow event search.
Return	`osid.workflow.event.WorkflowEventSearch`		the workflow event search
Compliance	`mandatory`		This method must be implemented.
Method	getWorkflowEventSearchOrder
Description	Gets a workflow event search order. The `WorkflowEventSearchOrder` is supplied to a `WorkflowEventSearch` to specify the ordering of results.
Return	`osid.workflow.event.WorkflowEventSearchOrder`		the workflow event search order
Compliance	`mandatory`		This method must be implemented.
Method	getWorkflowEventsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.workflow.event.WorkflowEventQuery`	`workflowEventQuery`	the workflow event query
Parameters	`osid.workflow.event.WorkflowEventSearch`	`workflowEventSearch`	the workflow event search
Return	`osid.workflow.event.WorkflowEventSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`workflowEventQuery` or `workflowEventSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`workflowEventQuery` or `workflowEventSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getWorkflowEventQueryFromInspector
Description	Gets a workflow event query from an inspector. The inspector is available from a `WorkflowEventSearchResults` .
Parameters	`osid.workflow.event.WorkflowEventQueryInspector`	`workflowEventQueryInspector`	a workflow event query inspector
Return	`osid.workflow.event.WorkflowEventQuery`		the workflow event query
Errors	NULL_ARGUMENT		`workflowEventQueryInspector` is `null`
Errors	UNSUPPORTED		`workflowEventQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.