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

Interface	osid.ordering.rules.OrderingRulesManager
Implements	`osid.OsidManager`
Implements	`osid.ordering.rules.OrderingRulesProfile`
Description	The ordering rules manager provides access to ordering rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `PriceEnablerLookupSession:` a session to retrieve price enablers `PriceEnablerQuerySession:` a session to query for price enablers `PriceEnablerSearchSession:` a session to search for price enablers `PriceEnablerAdminSession:` a session to create and delete price enablers `PriceEnablerNotificationSession:` a session to receive notifications pertaining to price enabler changes `PriceEnablerStoreSession:` a session to look up price enabler store mappings `PriceEnablerStoreAssignmentSession:` a session to manage price enabler to store mappings `PriceEnablerSmartStoreSession:` a session to manage dynamic stores of price enablers `PriceEnablerPriceRuleLookupSession:` a session to look up price enabler to price mappings `PriceEnablerPriceRuleApplicationSession:` a session to apply price enablers to prices
Method	getPriceEnablerLookupSession
Description	Gets the `OsidSession` associated with the price enabler lookup service.
Return	`osid.ordering.rules.PriceEnablerLookupSession`		a `PriceEnablerLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPriceEnablerLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerLookup()` is `true.`
Method	getPriceEnablerLookupSessionForStore
Description	Gets the `OsidSession` associated with the price enabler lookup service for the given store.
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store`
Return	`osid.ordering.rules.PriceEnablerLookupSession`		a `PriceEnablerLookupSession`
Errors	NOT_FOUND		no `Store` found by the given `Id`
	NULL_ARGUMENT		`storeId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPriceEnablerLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerLookup()` and `supportsVisibleFederation()` are `true.`
Method	getPriceEnablerQuerySession
Description	Gets the `OsidSession` associated with the price enabler query service.
Return	`osid.ordering.rules.PriceEnablerQuerySession`		a `PriceEnablerQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPriceEnablerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerQuery()` is `true.`
Method	getPriceEnablerQuerySessionForStore
Description	Gets the `OsidSession` associated with the price enabler query service for the given store.
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store`
Return	`osid.ordering.rules.PriceEnablerQuerySession`		a `PriceEnablerQuerySession`
Errors	NOT_FOUND		no `Store` found by the given `Id`
	NULL_ARGUMENT		`storeId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPriceEnablerQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerQuery()` and `supportsVisibleFederation()` are `true.`
Method	getPriceEnablerSearchSession
Description	Gets the `OsidSession` associated with the price enabler search service.
Return	`osid.ordering.rules.PriceEnablerSearchSession`		a `PriceEnablerSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPriceEnablerSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerSearch()` is `true.`
Method	getPriceEnablerSearchSessionForStore
Description	Gets the `OsidSession` associated with the price enablers earch service for the given store.
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store`
Return	`osid.ordering.rules.PriceEnablerSearchSession`		a `PriceEnablerSearchSession`
Errors	NOT_FOUND		no `Store` found by the given `Id`
	NULL_ARGUMENT		`storeId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPriceEnablerSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerSearch()` and `supportsVisibleFederation()` are `true.`
Method	getPriceEnablerAdminSession
Description	Gets the `OsidSession` associated with the price enabler administration service.
Return	`osid.ordering.rules.PriceEnablerAdminSession`		a `PriceEnablerAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPriceEnablerAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerAdmin()` is `true.`
Method	getPriceEnablerAdminSessionForStore
Description	Gets the `OsidSession` associated with the price enabler administration service for the given store.
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store`
Return	`osid.ordering.rules.PriceEnablerAdminSession`		a `PriceEnablerAdminSession`
Errors	NOT_FOUND		no `Store` found by the given `Id`
	NULL_ARGUMENT		`storeId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPriceEnablerAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getPriceEnablerNotificationSession
Description	Gets the `OsidSession` associated with the price enabler notification service.
Parameters	`osid.ordering.rules.PriceEnablerReceiver`	`priceEnablerReceiver`	the notification callback
Return	`osid.ordering.rules.PriceEnablerNotificationSession`		a `PriceEnablerNotificationSession`
Errors	NULL_ARGUMENT		`priceEnablerReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPriceEnablerNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerNotification()` is `true.`
Method	getPriceEnablerNotificationSessionForStore
Description	Gets the `OsidSession` associated with the price enabler notification service for the given store.
Parameters	`osid.ordering.rules.PriceEnablerReceiver`	`priceEnablerReceiver`	the notification callback
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store`
Return	`osid.ordering.rules.PriceEnablerNotificationSession`		a `PriceEnablerNotificationSession`
Errors	NOT_FOUND		no store found by the given `Id`
	NULL_ARGUMENT		`priceEnablerReceiver` or `storeId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPriceEnablerNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerNotification()` and `supportsVisibleFederation()` are `true.`
Method	getPriceEnablerStoreSession
Description	Gets the `OsidSession` to lookup price enabler/store mappings for price enablers.
Return	`osid.ordering.rules.PriceEnablerStoreSession`		a `PriceEnablerStoreSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPriceEnablerStore()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerStore()` is `true.`
Method	getPriceEnablerStoreAssignmentSession
Description	Gets the `OsidSession` associated with assigning price enablers to stores for price.
Return	`osid.ordering.rules.PriceEnablerStoreAssignmentSession`		a `PriceEnablerStoreAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPriceEnablerStoreAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerStoreAssignment()` is `true.`
Method	getPriceEnablerSmartStoreSession
Description	Gets the `OsidSession` to manage price enabler smart stores.
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store`
Return	`osid.ordering.rules.PriceEnablerSmartStoreSession`		a `PriceEnablerSmartStoreSession`
Errors	NOT_FOUND		no `Store` found by the given `Id`
	NULL_ARGUMENT		`storeId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPriceEnablerSmartStore()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerSmartStore()` is `true.`
Method	getPriceEnablerRuleLookupSession
Description	Gets the `OsidSession` associated with the price enabler price mapping lookup service for looking up the rules applied to the store.
Return	`osid.ordering.rules.PriceEnablerRuleLookupSession`		a `PriceEnablerRuleLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPriceEnablerRuleLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerRuleLookup()` is `true.`
Method	getPriceEnablerRuleLookupSessionForStore
Description	Gets the `OsidSession` associated with the price enabler price mapping lookup service for the given store for looking up rules applied to an store.
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store`
Return	`osid.ordering.rules.PriceEnablerRuleLookupSession`		a `PriceEnablerRuleLookupSession`
Errors	NOT_FOUND		no `Store` found by the given `Id`
	NULL_ARGUMENT		`storeId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPriceEnablerRuleLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerRuleLookup()` and `supportsVisibleFederation()` are `true.`
Method	getPriceEnablerRuleApplicationSession
Description	Gets the `OsidSession` associated with the price enabler price assignment service to apply enablers to stores.
Return	`osid.ordering.rules.PriceEnablerRuleApplicationSession`		a `PriceEnablerRuleApplicationSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPriceEnablerRuleApplication()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerRuleApplication()` is `true.`
Method	getPriceEnablerRuleApplicationSessionForStore
Description	Gets the `OsidSession` associated with the price enabler price assignment service for the given store to apply enablers to stores.
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store`
Return	`osid.ordering.rules.PriceEnablerRuleApplicationSession`		a `PriceEnablerRuleApplicationSession`
Errors	NOT_FOUND		no `Store` found by the given `Id`
	NULL_ARGUMENT		`storeId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPriceEnablerRuleApplication()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceEnablerRuleApplication()` and `supportsVisibleFederation()` are `true`