org.osid.ordering.rules

Interface OrderingRulesProxyManager

All Superinterfaces:

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

public interface OrderingRulesProxyManager
extends OsidProxyManager, OrderingRulesProfile

The ordering rules proxy manager provides access to ordering rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. 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(Proxy proxy) Gets the OsidSession associated with the price enabler administration service.
PriceEnablerAdminSession	getPriceEnablerAdminSessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the price enabler administration service for the given store.
PriceEnablerLookupSession	getPriceEnablerLookupSession(Proxy proxy) Gets the OsidSession associated with the price enabler lookup service.
PriceEnablerLookupSession	getPriceEnablerLookupSessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the price enabler lookup service for the given store.
PriceEnablerNotificationSession	getPriceEnablerNotificationSession(PriceEnablerReceiver priceEnablerReceiver, Proxy proxy) Gets the OsidSession associated with the price enabler notification service.
PriceEnablerNotificationSession	getPriceEnablerNotificationSessionForStore(PriceEnablerReceiver priceEnablerReceiver, Id storeId, Proxy proxy) Gets the OsidSession associated with the price enabler notification service for the given store.
PriceEnablerQuerySession	getPriceEnablerQuerySession(Proxy proxy) Gets the OsidSession associated with the price enabler query service.
PriceEnablerQuerySession	getPriceEnablerQuerySessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the price enabler query service for the given store.
PriceEnablerRuleApplicationSession	getPriceEnablerRuleApplicationSession(Proxy proxy) Gets the OsidSession associated with the price enabler price assignment service to apply enablers to stores.
PriceEnablerRuleApplicationSession	getPriceEnablerRuleApplicationSessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the price enabler price assignment service for the given store to apply enablers to stores.
PriceEnablerRuleLookupSession	getPriceEnablerRuleLookupSession(Proxy proxy) 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, Proxy proxy) 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(Proxy proxy) Gets the OsidSession associated with the price enabler search service.
PriceEnablerSearchSession	getPriceEnablerSearchSessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the price enablers earch service for the given store.
PriceEnablerSmartStoreSession	getPriceEnablerSmartStoreSession(Id storeId, Proxy proxy) Gets the OsidSession to manage price enabler smart stores.
PriceEnablerStoreAssignmentSession	getPriceEnablerStoreAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning price enablers to stores for price.
PriceEnablerStoreSession	getPriceEnablerStoreSession(Proxy proxy) Gets the OsidSession to lookup price enabler/store mappings for price enablers.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the price enabler lookup service.

Parameters:

proxy - a proxy

Returns:

a PriceEnablerLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a PriceEnablerLookupSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the price enabler query service.

Parameters:

proxy - a proxy

Returns:

a PriceEnablerQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a PriceEnablerQuerySession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy 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(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the price enabler search service.

Parameters:

proxy - a proxy

Returns:

a PriceEnablerSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a PriceEnablerSearchSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the price enabler administration service.

Parameters:

proxy - a proxy

Returns:

a PriceEnablerAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a PriceEnablerAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy 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,
                                                                 Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the price enabler notification service.

Parameters:

priceEnablerReceiver - the notification callback

proxy - a proxy

Returns:

a PriceEnablerNotificationSession

Throws:

NullArgumentException - priceEnablerReceiver or proxy 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,
                                                                         Proxy proxy)
                                                                           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

proxy - a proxy

Returns:

a PriceEnablerNotificationSession

Throws:

NotFoundException - no store found by the given Id

NullArgumentException - priceEnablerReceiver, storeId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a PriceEnablerStoreSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerStore() is false

Compliance:

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

getPriceEnablerStoreAssignmentSession

PriceEnablerStoreAssignmentSession getPriceEnablerStoreAssignmentSession(Proxy proxy)
                                                                         throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a PriceEnablerStoreAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession to manage price enabler smart stores.

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a PriceEnablerSmartStoreSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy 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(Proxy proxy)
                                                               throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a PriceEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceEnablerPriceRuleLookup() is false

Compliance:

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

getPriceEnablerRuleLookupSessionForStore

PriceEnablerRuleLookupSession getPriceEnablerRuleLookupSessionForStore(Id storeId,
                                                                     Proxy proxy)
                                                                       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

proxy - a proxy

Returns:

a PriceEnablerRuleLookupSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy 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(Proxy proxy)
                                                                         throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a PriceEnablerPricApplicationSession

Throws:

NullArgumentException - proxy is null

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,
                                                                               Proxy proxy)
                                                                                 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

proxy - a proxy

Returns:

a PriceEnablerRuleApplicationSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy 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.