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

Interface	osid.workflow.rules.StepProcessorEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `StepProcessorEnablers.` 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 step processor enabler methods in this session operate, retrieve and pertain to step processor enablers defined explicitly in the current office. Using an isolated view is useful for managing `StepProcessorEnablers` with the `StepProcessorEnablerAdminSession.` federated office view: All step processor enabler methods in this session operate, retrieve and pertain to all step processor enablers defined in this office and any other step processor enablers implicitly available in this office through office inheritence. actuve step processor enabler view: All step processor enabler lookup methods return active step processor enablers. any stayus step processor enabler view: Step processor enablers of any active or inactive status are returned from methods. 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 the methods in this session.
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	canLookupStepProcessorEnablers
Description	Tests if this user can perform `StepProcessorEnablers` 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	useComparativeStepProcessorEnablerView
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	usePlenaryStepProcessorEnablerView
Description	A complete view of the `StepProcessorEnabler` 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 step 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	useActiveStepProcessorEnablerView
Description	Only active step processor enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusStepProcessorEnablerView
Description	All active and inactive step processor enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getStepProcessorEnabler
Description	Gets the `StepProcessorEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `StepProcessorEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `StepProcessorEnabler` and retained for compatibility. In active mode, step processor enablers are returned that are currently active. In any status mode, active and inactive step processors enablers are returned.
Parameters	`osid.id.Id`	`stepProcessorEnablerId`	`Id` of the `StepProcessorEnabler`
Return	`osid.workflow.rules.StepProcessorEnabler`		the step processor enabler
Errors	NOT_FOUND		`stepProcessorEnablerId` not found
	NULL_ARGUMENT		`stepProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getStepProcessorEnablersByIds
Description	Gets a `StepProcessorEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the step processor enablers specified in the `Id` list, in the order of the list, including duplicates, or an error results if a `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `StepProcessorEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, step processor enablers are returned that are currently active. In any status mode, active and inactive step processors enablers are returned.
Parameters	`osid.id.IdList`	`stepProcessorEnablerIds`	the list of `Ids` to retrieve
Return	`osid.workflow.rules.StepProcessorEnablerList`		the returned `StepProcessorEnabler` list
Errors	NOT_FOUND		a `Id` was not found
	NULL_ARGUMENT		`stepProcessorEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStepProcessorEnablersByGenusType
Description	Gets a `StepProcessorEnablerList` corresponding to the given step processor enabler genus `Type` which does not include step processor enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known step processor enablers or an error results. Otherwise, the returned list may contain only those step processor enablers that are accessible through this session. In active mode, step processor enablers are returned that are currently active. In any status mode, active and inactive step processors enablers are returned.
Parameters	`osid.type.Type`	`stepProcessorEnablerGenusType`	a step processor enabler genus type
Return	`osid.workflow.rules.StepProcessorEnablerList`		the returned `StepProcessorEnabler` list
Errors	NULL_ARGUMENT		`stepProcessorEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStepProcessorEnablersByParentGenusType
Description	Gets a `StepProcessorEnablerList` corresponding to the given step processor enabler genus `Type` and include any additional step processor enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known step processor enablers or an error results. Otherwise, the returned list may contain only those step processor enablers that are accessible through this session. In active mode, step processor enablers are returned that are currently active. In any status mode, active and inactive step processors enablers are returned.
Parameters	`osid.type.Type`	`stepProcessorEnablerGenusType`	a step processor enabler genus type
Return	`osid.workflow.rules.StepProcessorEnablerList`		the returned `StepProcessorEnabler` list
Errors	NULL_ARGUMENT		`stepProcessorEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStepProcessorEnablersByRecordType
Description	Gets a `StepProcessorEnablerList` containing the given step processor enabler record `Type.` In plenary mode, the returned list contains all known step processor enablers or an error results. Otherwise, the returned list may contain only those step processor enablers that are accessible through this session. In active mode, step processor enablers are returned that are currently active. In any status mode, active and inactive step processors enablers are returned.
Parameters	`osid.type.Type`	`stepProcessorEnablerRecordType`	a step processor enabler record type
Return	`osid.workflow.rules.StepProcessorEnablerList`		the returned `StepProcessorEnabler` list
Errors	NULL_ARGUMENT		`stepProcessorEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStepProcessorEnablersOnDate
Description	Gets a `StepProcessorEnablerList` that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known step processor enablers or an error results. Otherwise, the returned list may contain only those step processor enablers that are accessible through this session. In active mode, step processor enablers are returned that are currently active. In any status mode, active and inactive step processors enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.workflow.rules.StepProcessorEnablerList`		the returned `StepProcessorEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater tha `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStepProcessorEnablersOnDateWithAgent
Description	Gets a `StepProcessorEnablerList` that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known step processor enablers or an error results. Otherwise, the returned list may contain only those step processor enablers that are accessible through this session. In active mode, step processor enablers are returned that are currently active. In any status mode, active and inactive step processors enablers are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.workflow.rules.StepProcessorEnablerList`		the returned `StepProcessorEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater tha `to`
	NULL_ARGUMENT		`agentId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStepProcessorEnablers
Description	Gets all `StepProcessorEnablers.` In plenary mode, the returned list contains all known step processor enablers or an error results. Otherwise, the returned list may contain only those step processor enablers that are accessible through this session. In active mode, step processor enablers are returned that are currently active. In any status mode, active and inactive step processors enablers are returned.
Return	`osid.workflow.rules.StepProcessorEnablerList`		the returned `StepProcessorEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.