OSID - osid.ordering.PriceScheduleLookupSession Service Interface Definition

Interface	osid.ordering.PriceScheduleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `PriceSchedule` objects. The `PriceSchedule` represents a collection of prices. 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 order methods in this session operate, retrieve and pertain to price schedules defined explicitly in the current store. Using an isolated view is useful for managing price schedules with the `PriceScheduleAdminSession.` federated store view: All priice schedule lookup methods in this session operate, retrieve and pertain to all price schedules defined in this store and any other stores implicitly available in this store through store inheritence.
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	canLookupPriceSchedules
Description	Tests if this user can perform `Price` 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 not 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	useComparativePriceScheduleView
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	usePlenaryPriceScheduleView
Description	A complete view of the `PriceSchedule` 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 schedules 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 retrievals to this store only.
Compliance	`mandatory`		This method is must be implemented.
Method	getPriceSchedule
Description	Gets the `PriceSchedule` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `PriceSchedule` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `PriceSchedule` and retained for compatibility.
Parameters	`osid.id.Id`	`priceScheduleId`	`Id` of the `PriceSchedule`
Return	`osid.ordering.PriceSchedule`		the price schedule
Errors	NOT_FOUND		`priceScheduleId` not found
	NULL_ARGUMENT		`priceScheduleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getPriceScheduleByPrice
Description	Gets the `PriceSchedule` by a `Price` `Id.`
Parameters	`osid.id.Id`	`priceId`	`Id` of a `Price`
Return	`osid.ordering.PriceSchedule`		the price schedule
Errors	NOT_FOUND		`priceId` not found
	NULL_ARGUMENT		`priceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getPriceSchedulesByIds
Description	Gets a `PriceScheduleList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the price schedules 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 `PriceSchedules` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`priceScheduleIds`	the list of `Ids` to retrieve
Return	`osid.ordering.PriceScheduleList`		the returned `PriceSchedule` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`priceScheduleIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPriceSchedulesByGenusType
Description	Gets a `PriceScheduleList` corresponding to the given price schedule genus `Type` which does not include price schedules of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known price schedules or an error results. Otherwise, the returned list may contain only those price schedules that are accessible through this session.
Parameters	`osid.type.Type`	`priceScheduleGenusType`	a price schedule genus type
Return	`osid.ordering.PriceScheduleList`		the returned `PriceSchedule` list
Errors	NULL_ARGUMENT		`priceScheduleGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPriceSchedulesByParentGenusType
Description	Gets a `PriceScheduleList` corresponding to the given price schedule genus `Type` and include any additional price schedules with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known price schedules or an error results. Otherwise, the returned list may contain only those price schedules that are accessible through this session.
Parameters	`osid.type.Type`	`priceScheduleGenusType`	a price schedule genus type
Return	`osid.ordering.PriceScheduleList`		the returned `PriceSchedule` list
Errors	NULL_ARGUMENT		`priceScheduleGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPriceSchedulesByRecordType
Description	Gets a `PriceScheduleList` containing the given repository record `Type.` In plenary mode, the returned list contains all known price schedules or an error results. Otherwise, the returned list may contain only those price schedules that are accessible through this session.
Parameters	`osid.type.Type`	`priceScheduleRecordType`	a price schedule record type
Return	`osid.ordering.PriceScheduleList`		the returned `PriceSchedule` list
Errors	NULL_ARGUMENT		`priceScheduleRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPriceSchedules
Description	Gets all `PriceSchedules.` In plenary mode, the returned list contains all known price schedules or an error results. Otherwise, the returned list may contain only those price schedules that are accessible through this session.
Return	`osid.ordering.PriceScheduleList`		a list of `PriceSchedules`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.