OSID - osid.workflow.rules.ProcessConstrainerSmartOfficeSession Service Interface Definition

Interface	osid.workflow.rules.ProcessConstrainerSmartOfficeSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ProcessConstrainerQuery` can be retrieved from this session and mapped to this `Office` to create a virtual collection of `ProcessConstrainers` . The process constrainers may be sequenced using the `ProcessConstrainerSearchOrder` from this session. This `Office` has a default query that matches any process constrainer and a default search order that specifies no sequencing. The queries may be examined using a `ProcessConstrainerQueryInspector` . The query may be modified by converting the inspector back to a `ProcessConstrainerQuery` .
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	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	getProcessConstrainerQuery
Description	Gets a process constrainer query.
Return	`osid.workflow.rules.ProcessConstrainerQuery`		the process constrainer query
Compliance	`mandatory`		This method must be implemented.
Method	getProcessConstrainerSearchOrder
Description	Gets a process constrainer search order.
Return	`osid.workflow.rules.ProcessConstrainerSearchOrder`		the process constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	applyProcessConstrainerQuery
Description	Applies a process constrainer query to this office.
Parameters	`osid.workflow.rules.ProcessConstrainerQuery`	`processConstrainerQuery`	the process constrainer query
Errors	NULL_ARGUMENT		`processConstrainerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`processConstrainerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectProcessConstrainerQuery
Description	Gets a process constrainer query inspector for this office.
Return	`osid.workflow.rules.ProcessConstrainerQueryInspector`		the process constrainer query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyProcessConstrainerSequencing
Description	Applies a process constrainer search order to this office.
Parameters	`osid.workflow.rules.ProcessConstrainerSearchOrder`	`processConstrainerSearchOrder`	the process constrainer search order
Errors	NULL_ARGUMENT		`processConstrainerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`processConstrainerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProcessConstrainerQueryFromInspector
Description	Gets a process constrainer query from an inspector.
Parameters	`osid.workflow.rules.ProcessConstrainerQueryInspector`	`processConstrainerQueryInspector`	a process constrainer query inspector
Return	`osid.workflow.rules.ProcessConstrainerQuery`		the process constrainer query
Errors	NULL_ARGUMENT		`processConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`processConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.