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

Interface	osid.workflow.rules.ProcessProcessorEnablerLookupSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods for retrieving `ProcessProcessorEnablers` . This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated office view: All process processor enabler methods in this session operate, retrieve and pertain to process processor enablers defined explicitly in the current office Using an isolated view is useful for managing `ProcessProcessorEnablers` with the `ProcessProcessorEnablerAdminSession` . federated office view: All process processor enabler methods in this session operate, retrieve and pertain to all process processor enablers defined in this office and any other process processor enablers implicitly available in this office through office inheritence. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedOfficeView()` and `useIsolatedOfficeView() behave` as a radio group and one should be selected before invoking any lookup methods.
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	canLookupProcessProcessorEnablers
Description	Tests if this user can perform `ProcessProcessorEnabler` 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 opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeProcessProcessorEnablerView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryProcessProcessorEnablerView
Description	A complete view of the `ProcessProcessorEnabler` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedOfficeView
Description	Federates the view for methods in this session. A federated view will include process processor enablers 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 lookups to this office only.
Compliance	`mandatory`		This method is must be implemented.
Method	getProcessProcessorEnabler
Description	Gets the `ProcessProcessorEnabler` specified by its `Id` . In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `ProcessProcessorEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `ProcessProcessorEnabler and re` tained for compatibility.
Parameters	`osid.id.Id`	`processProcessorEnablerId`	`Id` of the `ProcessProcessorEnabler`
Return	`osid.workflow.rules.ProcessProcessorEnabler`		the process processor enabler
Errors	NOT_FOUND		`processProcessorEnablerId` not found
	NULL_ARGUMENT		`processProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getProcessProcessorEnablersByIds
Description	Gets a `ProcessProcessorEnablerList` corresponding to the given `IdList` . In plenary mode, the returned list contains all of the process processor enablers specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `ProcessProcessorEnablers may be` omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`processProcessorEnablerIds`	the list of `Ids` to retrieve
Return	`osid.workflow.rules.ProcessProcessorEnablerList`		the returned `ProcessProcessorEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`processProcessorEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProcessProcessorEnablersByGenusType
Description	Gets a `ProcessProcessorEnablerList` corresponding to the given process processor enabler genus `Type` which does not include process processor enablers of genus types derived from the specified `Type` . `In` plenary mode, the returned list contains all known process processor enablers or an error results. Otherwise, the returned list may contain only those process processor enablers that are accessible through this session.
Parameters	`osid.type.Type`	`processProcessorEnablerGenusType`	a process processor enabler genus type
Return	`osid.workflow.rules.ProcessProcessorEnablerList`		the returned `ProcessProcessorEnabler` list
Errors	NULL_ARGUMENT		`processProcessorEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProcessProcessorEnablersByParentGenusType
Description	Gets a `ProcessProcessorEnablerList` corresponding to the given process processor enabler genus `Type` and include any additional process processor enablers with genus types derived from the specified `Type` . `In` plenary mode, the returned list contains all known process processor enablers or an error results. Otherwise, the returned list may contain only those process processor enablers that are accessible through this session.
Parameters	`osid.type.Type`	`processProcessorEnablerGenusType`	a process processor genus type
Return	`osid.workflow.rules.ProcessProcessorEnablerList`		the returned `ProcessProcessorEnabler` list
Errors	NULL_ARGUMENT		`processProcessorEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProcessProcessorEnablersByRecordType
Description	Gets a `ProcessProcessorEnablerList` containing the given process processor enabler record `Type` . `In` plenary mode, the returned list contains all known process processor enablers or an error results. Otherwise, the returned list may contain only those process processor enablers that are accessible through this session.
Parameters	`osid.type.Type`	`processProcessorEnablerRecordType`	a process processor enabler record type
Return	`osid.workflow.rules.ProcessProcessorEnablerList`		the returned `ProcessProcessorEnabler` list
Errors	NULL_ARGUMENT		`processProcessorEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProcessProcessorEnablers
Description	Gets all `ProcessProcessorEnablers` . `In plen` ary mode, the returned list contains all known process processor enablers or an error results. Otherwise, the returned list may contain only those process processor enablers that are accessible through this session.
Return	`osid.workflow.rules.ProcessProcessorEnablerList`		a list of `ProcessProcessorEnablers`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.