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

Interface	osid.workflow.rules.ProcessConstrainerSearchSession
Implements	`osid.workflow.rules.ProcessConstrainerQuerySession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods for searching among `ProcessConstrainers` . The search query is constructed using the `ProcessConstrainerQuery` . `getProcessConstrainersByQuery()` is the basic search method and returns a list of `ProcessConstrainers` . A more advanced search may be performed with `getProcessConstrainersBySearch()` . It accepts a `ProcessConstrainerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProcessConstrainersBySearch()` returns a `ProcessConstrainerSearchResults` that can be used to access the resulting `ProcessConstrainerList` or be used to perform a search within the result set through `ProcessConstrainerSearch` . This session defines views that offer differing behaviors for searching. federated office view: searches include process constrainers in offices of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to process constrainers in this office Process constrainers may have a query record indicated by their respective record types. The query record is accessed via the `ProcessConstrainerQuery` .
Method	getProcessConstrainerSearch
Description	Gets a process constrainer search.
Return	`osid.workflow.rules.ProcessConstrainerSearch`		the process constrainer search
Compliance	`mandatory`		This method must be implemented.
Method	getProcessConstrainerSearchOrder
Description	Gets a process constrainer search order. The `ProcessConstrainerSearchOrder` is supplied to a `ProcessConstrainerSearch` to specify the ordering of results.
Return	`osid.workflow.rules.ProcessConstrainerSearchOrder`		the process constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	getProcessConstrainersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.workflow.rules.ProcessConstrainerQuery`	`processConstrainerQuery`	the process constrainer query
Parameters	`osid.workflow.rules.ProcessConstrainerSearch`	`processConstrainerSearch`	the process constrainer search
Return	`osid.workflow.rules.ProcessConstrainerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`processConstrainerQuery` or `processConstrainerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`processConstrainerQuery` or `processConstrainerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProcessConstrainerQueryFromInspector
Description	Gets a process constrainer query from an inspector. The inspector is available from a `ProcessConstrainerSearchResults` .
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.