OSID - osid.resourcing.rules.CommissionEnablerLookupSession Service Interface Definition

Interface	osid.resourcing.rules.CommissionEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `CommissionEnablers.` 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 foundry view: All commission enabler methods in this session operate, retrieve and pertain to commission enabler defined explicitly in the current foundry. Using an isolated view is useful for managing `CommissionEnablers` with the `CommissionEnablerAdminSession.` federated foundry view: All commission enabler methods in this session operate, retrieve and pertain to all commission enabler defined in this foundry and any other commission enabler implicitly available in this foundry through foundry inheritence. active commission enabler view: All commission enabler lookup methods return active commission enablers. any status commission enabler view: Commission 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 `useFederatedFoundryView()` and `useIsolatedFoundryView()` behave as a radio group and one should be selected before invoking the methods in this session.
Method	getFoundryId
Description	Gets the `Foundry` `Id` associated with this session.
Return	`osid.id.Id`		the `Foundry Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFoundry
Description	Gets the `Foundry` associated with this session.
Return	`osid.resourcing.Foundry`		the foundry
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupCommissionEnablers
Description	Tests if this user can perform `CommissionEnablers` 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	useComparativeCommissionEnablerView
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	usePlenaryCommissionEnablerView
Description	A complete view of the `CommissionEnabler` 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	useFederatedFoundryView
Description	Federates the view for methods in this session. A federated view will include commission enabler in foundries which are children of this foundry in the foundry hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFoundryView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this foundry only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveCommissionEnablerView
Description	Only active commission enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusCommissionEnablerView
Description	All active and inactive commission enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getCommissionEnabler
Description	Gets the `CommissionEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `CommissionEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `CommissionEnabler` and retained for compatibility. In active mode, commission enablers are returned that are currently active. In any status mode, active and inactive commission enablers are returned.
Parameters	`osid.id.Id`	`commissionEnablerId`	`Id` of the `CommissionEnabler`
Return	`osid.resourcing.rules.CommissionEnabler`		the commission enabler
Errors	NOT_FOUND		`commissionEnablerId` not found
	NULL_ARGUMENT		`commissionEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCommissionEnablersByIds
Description	Gets a `CommissionEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the commission enabler 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 `CommissionEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, commission enablers are returned that are currently active. In any status mode, active and inactive commission enablers are returned.
Parameters	`osid.id.IdList`	`commissionEnablerIds`	the list of `Ids` to retrieve
Return	`osid.resourcing.rules.CommissionEnablerList`		the returned `CommissionEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`commissionEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionEnablersByGenusType
Description	Gets a `CommissionEnablerList` corresponding to the given commission enabler genus `Type` which does not include commission enabler of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known commission enabler or an error results. Otherwise, the returned list may contain only those commission enabler that are accessible through this session. In active mode, commission enablers are returned that are currently active. In any status mode, active and inactive commission enablers are returned.
Parameters	`osid.type.Type`	`commissionEnablerGenusType`	a commission enabler genus type
Return	`osid.resourcing.rules.CommissionEnablerList`		the returned `CommissionEnabler` list
Errors	NULL_ARGUMENT		`commissionEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionEnablersByParentGenusType
Description	Gets a `CommissionEnablerList` corresponding to the given commission enabler genus `Type` and include any additional commission enabler with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known commission enabler or an error results. Otherwise, the returned list may contain only those commission enabler that are accessible through this session. In active mode, commission enablers are returned that are currently active. In any status mode, active and inactive commission enablers are returned.
Parameters	`osid.type.Type`	`commissionEnablerGenusType`	a commission enabler genus type
Return	`osid.resourcing.rules.CommissionEnablerList`		the returned `CommissionEnabler` list
Errors	NULL_ARGUMENT		`commissionEnablerIdGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionEnablersByRecordType
Description	Gets a `CommissionEnablerList` containing the given commission enabler record `Type.` In plenary mode, the returned list contains all known commission enabler or an error results. Otherwise, the returned list may contain only those commission enabler that are accessible through this session. In active mode, commission enablers are returned that are currently active. In any status mode, active and inactive commission enablers are returned.
Parameters	`osid.type.Type`	`commissionEnablerRecordType`	a commission enabler record type
Return	`osid.resourcing.rules.CommissionEnablerList`		the returned `CommissionEnabler` list
Errors	NULL_ARGUMENT		`commissionEnablerRecordTYpe` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionEnablersOnDate
Description	Gets a `CommissionEnablerList` 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 commission enablers or an error results. Otherwise, the returned list may contain only those commission enablers that are accessible through this session. In active mode, commission enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive commission enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.resourcing.rules.CommissionEnablerList`		the returned `CommissionEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `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	getCommissionEnablersOnDateWithAgent
Description	Gets a `CommissionEnablerList` that are effective for the entire given date range inclusive but not confined to the date range and evaluated againstthe given agent. In plenary mode, the returned list contains all known commission enablers or an error results. Otherwise, the returned list may contain only those commission enablers that are accessible through this session. In active mode, commission enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive commission 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.resourcing.rules.CommissionEnablerList`		the returned `CommissionEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `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	getCommissionEnablers
Description	Gets all `CommissionEnablers.` In plenary mode, the returned list contains all known commission enabler or an error results. Otherwise, the returned list may contain only those commission enabler that are accessible through this session. In active mode, commission enablers are returned that are currently active. In any status mode, active and inactive commission enablers are returned.
Return	`osid.resourcing.rules.CommissionEnablerList`		the returned `CommissionEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.