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

Interface	osid.workflow.event.WorkflowEventSmartOfficeSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.event.WorkflowEventManager`
Used By	`osid.workflow.event.WorkflowEventProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `WorkflowEventQuery` can be retrieved from this session and mapped to this `Office` to create a virtual collection of `WorkflowEvents` . The workflow events may be sequenced using the `WorkflowEventSearchOrder` from this session. This `Office` has a default query that matches any workflow event and a default search order that specifies no sequencing. The queries may be examined using a `WorkflowEventQueryInspector. T` he query may be modified by converting the inspector back to a `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.OfficeList`		the office
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartOffices
Description	Tests if this user can manage smart offices. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart office management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getWorkflowEventSearchOrder
Description	Gets a workflow event search order.
Return	`osid.workflow.event.WorkflowEventSearchOrder`		the workflow event search order
Compliance	`mandatory`		This method must be implemented.
Method	applyWorkflowEventQuery
Description	Applies a workflow event query to this office.
Parameters	`osid.workflow.event.WorkflowEventQuery`	`workflowEventQuery`	the workflow event query
Errors	NULL_ARGUMENT		`workflowEventQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`workflowEventQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectWorkflowEventQuery
Description	Gets a workflow event query inspector for this office.
Return	`osid.workflow.event.WorkflowEventQueryInspector`		the workflow event query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyWorkflowEventSequencing
Description	Applies a workflow event search order to this office.
Parameters	`osid.workflow.event.WorkflowEventSearchOrder`	`workflowEventSearchOrder`	the workflow event search order
Errors	NULL_ARGUMENT		`workflowEventSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`workflowEventSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getWorkflowEventQueryFromInspector
Description	Gets a workflow event query from an inspector.
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.