org.osid.ordering.rules

Interface OrderingRulesManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OrderingRulesProfile, OsidManager, OsidProfile, Sourceable

public interface OrderingRulesManager
extends OsidManager, OrderingRulesProfile

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 Summary

Methods

Modifier and Type	Method and Description
PriceEnablerAdminSession	getPriceEnablerAdminSession() Gets the OsidSession associated with the price enabler administration service.
PriceEnablerAdminSession	getPriceEnablerAdminSessionForStore(Id storeId) Gets the OsidSession associated with the price enabler administration service for the given store.
PriceEnablerLookupSession	getPriceEnablerLookupSession() Gets the OsidSession associated with the price enabler lookup service.
PriceEnablerLookupSession	getPriceEnablerLookupSessionForStore(Id storeId) Gets the OsidSession associated with the price enabler lookup service for the given store.
PriceEnablerNotificationSession	getPriceEnablerNotificationSession(PriceEnablerReceiver priceEnablerReceiver) Gets the OsidSession associated with the price enabler notification service.
PriceEnablerNotificationSession	getPriceEnablerNotificationSessionForStore(PriceEnablerReceiver priceEnablerReceiver, Id storeId) Gets the OsidSession associated with the price enabler notification service for the given store.
PriceEnablerQuerySession	getPriceEnablerQuerySession() Gets the OsidSession associated with the price enabler query service.
PriceEnablerQuerySession	getPriceEnablerQuerySessionForStore(Id storeId) Gets the OsidSession associated with the price enabler query service for the given store.
PriceEnablerRuleApplicationSession	getPriceEnablerRuleApplicationSession() Gets the OsidSession associated with the price enabler price assignment service to apply enablers to stores.
PriceEnablerRuleApplicationSession	getPriceEnablerRuleApplicationSessionForStore(Id storeId) Gets the OsidSession associated with the price enabler price assignment service for the given store to apply enablers to stores.
PriceEnablerRuleLookupSession	getPriceEnablerRuleLookupSession() Gets the OsidSession associated with the price enabler price mapping lookup service for looking up the rules applied to the store.
PriceEnablerRuleLookupSession	getPriceEnablerRuleLookupSessionForStore(Id storeId) Gets the OsidSession associated with the price enabler price mapping lookup service for the given store for looking up rules applied to an store.
PriceEnablerSearchSession	getPriceEnablerSearchSession() Gets the OsidSession associated with the price enabler search service.
PriceEnablerSearchSession	getPriceEnablerSearchSessionForStore(Id storeId) Gets the OsidSession associated with the price enablers earch service for the given store.
PriceEnablerSmartStoreSession	getPriceEnablerSmartStoreSession(Id storeId) Gets the OsidSession to manage price enabler smart stores.
PriceEnablerStoreAssignmentSession	getPriceEnablerStoreAssignmentSession() Gets the OsidSession associated with assigning price enablers to stores for price.
PriceEnablerStoreSession	getPriceEnablerStoreSession() Gets the OsidSession to lookup price enabler/store mappings for price enablers.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.ordering.rules.OrderingRulesProfile

getPriceEnablerRecordTypes, getPriceEnablerSearchRecordTypes, supportsPriceEnablerAdmin, supportsPriceEnablerLookup, supportsPriceEnablerNotification, supportsPriceEnablerQuery, supportsPriceEnablerRecordType, supportsPriceEnablerRuleApplication, supportsPriceEnablerRuleLookup, supportsPriceEnablerSearch, supportsPriceEnablerSearchRecordType, supportsPriceEnablerSmartStore, supportsPriceEnablerStore, supportsPriceEnablerStoreAssignment, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getPriceEnablerLookupSession

PriceEnablerLookupSession getPriceEnablerLookupSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the price enabler lookup service.

Returns:

a PriceEnablerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerLookup() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerLookup() is true.

getPriceEnablerLookupSessionForStore

PriceEnablerLookupSession getPriceEnablerLookupSessionForStore(Id storeId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the price enabler lookup service for the given store.

Parameters:

storeId - the Id of the Store

Returns:

a PriceEnablerLookupSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerLookup() and supportsVisibleFederation() are true.

getPriceEnablerQuerySession

PriceEnablerQuerySession getPriceEnablerQuerySession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the price enabler query service.

Returns:

a PriceEnablerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerQuery() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerQuery() is true.

getPriceEnablerQuerySessionForStore

PriceEnablerQuerySession getPriceEnablerQuerySessionForStore(Id storeId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the price enabler query service for the given store.

Parameters:

storeId - the Id of the Store

Returns:

a PriceEnablerQuerySession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerQuery() and supportsVisibleFederation() are true.

getPriceEnablerSearchSession

PriceEnablerSearchSession getPriceEnablerSearchSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the price enabler search service.

Returns:

a PriceEnablerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerSearch() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerSearch() is true.

getPriceEnablerSearchSessionForStore

PriceEnablerSearchSession getPriceEnablerSearchSessionForStore(Id storeId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the price enablers earch service for the given store.

Parameters:

storeId - the Id of the Store

Returns:

a PriceEnablerSearchSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerSearch() and supportsVisibleFederation() are true.

getPriceEnablerAdminSession

PriceEnablerAdminSession getPriceEnablerAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the price enabler administration service.

Returns:

a PriceEnablerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerAdmin() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerAdmin() is true.

getPriceEnablerAdminSessionForStore

PriceEnablerAdminSession getPriceEnablerAdminSessionForStore(Id storeId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the price enabler administration service for the given store.

Parameters:

storeId - the Id of the Store

Returns:

a PriceEnablerAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerAdmin() and supportsVisibleFederation() are true.

getPriceEnablerNotificationSession

PriceEnablerNotificationSession getPriceEnablerNotificationSession(PriceEnablerReceiver priceEnablerReceiver)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the price enabler notification service.

Parameters:

priceEnablerReceiver - the notification callback

Returns:

a PriceEnablerNotificationSession

Throws:

NullArgumentException - priceEnablerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerNotification() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerNotification() is true.

getPriceEnablerNotificationSessionForStore

PriceEnablerNotificationSession getPriceEnablerNotificationSessionForStore(PriceEnablerReceiver priceEnablerReceiver,
                                                                         Id storeId)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

Gets the OsidSession associated with the price enabler notification service for the given store.

Parameters:

priceEnablerReceiver - the notification callback

storeId - the Id of the Store

Returns:

a PriceEnablerNotificationSession

Throws:

NotFoundException - no store found by the given Id

NullArgumentException - priceEnablerReceiver or storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerNotification() and supportsVisibleFederation() are true.

getPriceEnablerStoreSession

PriceEnablerStoreSession getPriceEnablerStoreSession()
                                                     throws OperationFailedException

Gets the OsidSession to lookup price enabler/store mappings for price enablers.

Returns:

a PriceEnablerStoreSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerStore() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerStore() is true.

getPriceEnablerStoreAssignmentSession

PriceEnablerStoreAssignmentSession getPriceEnablerStoreAssignmentSession()
                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning price enablers to stores for price.

Returns:

a PriceEnablerStoreAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerStoreAssignment() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerStoreAssignment() is true.

getPriceEnablerSmartStoreSession

PriceEnablerSmartStoreSession getPriceEnablerSmartStoreSession(Id storeId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession to manage price enabler smart stores.

Parameters:

storeId - the Id of the Store

Returns:

a PriceEnablerSmartStoreSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerSmartStore() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerSmartStore() is true.

getPriceEnablerRuleLookupSession

PriceEnablerRuleLookupSession getPriceEnablerRuleLookupSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with the price enabler price mapping lookup service for looking up the rules applied to the store.

Returns:

a PriceEnablerRuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerRuleLookup() is true.

getPriceEnablerRuleLookupSessionForStore

PriceEnablerRuleLookupSession getPriceEnablerRuleLookupSessionForStore(Id storeId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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:

storeId - the Id of the Store

Returns:

a PriceEnablerRuleLookupSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerRuleLookup() and supportsVisibleFederation() are true.

getPriceEnablerRuleApplicationSession

PriceEnablerRuleApplicationSession getPriceEnablerRuleApplicationSession()
                                                                         throws OperationFailedException

Gets the OsidSession associated with the price enabler price assignment service to apply enablers to stores.

Returns:

a PriceEnablerRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerRuleApplication() is true.

getPriceEnablerRuleApplicationSessionForStore

PriceEnablerRuleApplicationSession getPriceEnablerRuleApplicationSessionForStore(Id storeId)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

Gets the OsidSession associated with the price enabler price assignment service for the given store to apply enablers to stores.

Parameters:

storeId - the Id of the Store

Returns:

a PriceEnablerRuleApplicationSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPriceEnablerRuleApplication() and supportsVisibleFederation() are true