OSID - osid.ordering.rules.PriceEnablerLookupSession Service Interface Definition

Interface	osid.ordering.rules.PriceEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `PriceEnablers.` 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 store view: All price enabler methods in this session operate, retrieve and pertain to price enablers defined explicitly in the current store. Using an isolated view is useful for managing `PriceEnablers` with the `PriceEnablerAdminSession.` federated store view: All price enabler methods in this session operate, retrieve and pertain to all price enablers defined in this store and any other price enablers implicitly available in this store through store inheritence. active price enabler view: All price enabler lookup methods return active price enablers any status price enabler view: price enablers of anyactive 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 `useFederatedDistributorView()` and `useIsolatedDistributorView()` behave as a radio group and one should be selected before invoking the methods in this session.
Method	getStoreId
Description	Gets the `Store` `Id` associated with this session.
Return	`osid.id.Id`		the `Store Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getStore
Description	Gets the `Store` associated with this session.
Return	`osid.ordering.Store`		the store
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupPriceEnablers
Description	Tests if this user can perform `PriceEnablers` 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	useComparativePriceEnablerView
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	usePlenaryPriceEnablerView
Description	A complete view of the `PriceEnabler` 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	useFederatedStoreView
Description	Federates the view for methods in this session. A federated view will include price enablers in stores which are children of this store in the store hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedStoreView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this store only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActivePriceEnablerView
Description	Only active price enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusPriceEnablerView
Description	All price enablers of any active or inactive status are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getPriceEnabler
Description	Gets the `PriceEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `PriceEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `PriceEnabler` and retained for compatibility.
Parameters	`osid.id.Id`	`priceEnablerId`	`Id` of the `PriceEnabler`
Return	`osid.ordering.rules.PriceEnabler`		the price enabler
Errors	NOT_FOUND		`priceEnablerId` not found
	NULL_ARGUMENT		`priceEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getPriceEnablersByIds
Description	Gets a `PriceEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the price 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 `PriceEnablers` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`priceEnablerIds`	the list of `Ids` to retrieve
Return	`osid.ordering.rules.PriceEnablerList`		the returned `PriceEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`priceEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPriceEnablersByGenusType
Description	Gets a `PriceEnablerList` corresponding to the given price enabler genus `Type` which does not include price enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known price enablers or an error results. Otherwise, the returned list may contain only those price enablers that are accessible through this session.
Parameters	`osid.type.Type`	`priceEnablerGenusType`	a price enabler genus type
Return	`osid.ordering.rules.PriceEnablerList`		the returned `PriceEnabler` list
Errors	NULL_ARGUMENT		`priceEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPriceEnablersByParentGenusType
Description	Gets a `PriceEnablerList` corresponding to the given price enabler genus `Type` and include any additional price enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known price enablers or an error results. Otherwise, the returned list may contain only those price enablers that are accessible through this session.
Parameters	`osid.type.Type`	`priceEnablerGenusType`	a price enabler genus type
Return	`osid.ordering.rules.PriceEnablerList`		the returned `PriceEnabler` list
Errors	NULL_ARGUMENT		`priceEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPriceEnablersByRecordType
Description	Gets a `PriceEnablerList` containing the given price enabler record `Type.` In plenary mode, the returned list contains all known price enablers or an error results. Otherwise, the returned list may contain only those price enablers that are accessible through this session.
Parameters	`osid.type.Type`	`priceEnablerRecordType`	a price enabler record type
Return	`osid.ordering.rules.PriceEnablerList`		the returned `PriceEnabler` list
Errors	NULL_ARGUMENT		`priceEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPriceEnablersOnDate
Description	Gets a `PriceEnablerList` effective within the given date range. In plenary mode, the returned list contains all known price enablers or an error results. Otherwise, the returned list may contain only those price enablers that are accessible through this session.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.ordering.rules.PriceEnablerList`		the returned `PriceEnabler` 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	getPriceEnablersOnDateWithAgent
Description	Gets a `PriceEnablerList` effective within the given date range. In plenary mode, the returned list contains all known price enablers or an error results. Otherwise, the returned list may contain only those price enablers that are accessible through this session.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.ordering.rules.PriceEnablerList`		the returned `PriceEnabler` 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	getPriceEnablers
Description	Gets all `PriceEnablers.` In plenary mode, the returned list contains all known price enablers or an error results. Otherwise, the returned list may contain only those price enablers that are accessible through this session.
Return	`osid.ordering.rules.PriceEnablerList`		the returned `PriceEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.