Interface OrderingRulesProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OrderingRulesProfile, OsidProfile, OsidProxyManager, 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

Modifier and Type	Method	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 a 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 Closeable

close

Methods inherited from interface OrderingRulesProfile

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

Modifier and Type	Method	Description
TypeList	getPriceEnablerRecordTypes()	Gets the supported PriceEnabler record types.
TypeList	getPriceEnablerSearchRecordTypes()	Gets the supported PriceEnabler search record types.
boolean	supportsPriceEnablerAdmin()	Tests if a price enabler administrative service is supported.
boolean	supportsPriceEnablerLookup()	Tests if looking up price enablers is supported.
boolean	supportsPriceEnablerNotification()	Tests if a price enabler notification service is supported.
boolean	supportsPriceEnablerQuery()	Tests if querying price enablers is supported.
boolean	supportsPriceEnablerRecordType(Type priceEnablerRecordType)	Tests if the given PriceEnabler record type is supported.
boolean	supportsPriceEnablerRuleApplication()	Tests if a price enabler price rule application service is supported.
boolean	supportsPriceEnablerRuleLookup()	Tests if a price enabler price rule lookup service is supported.
boolean	supportsPriceEnablerSearch()	Tests if searching price enablers is supported.
boolean	supportsPriceEnablerSearchRecordType(Type priceEnablerSearchRecordType)	Tests if the given PriceEnabler search record type is supported.
boolean	supportsPriceEnablerSmartStore()	Tests if a price enabler store lookup service is supported.
boolean	supportsPriceEnablerStore()	Tests if a price enabler store lookup service is supported.
boolean	supportsPriceEnablerStoreAssignment()	Tests if a price enabler store service is supported.
boolean	supportsVisibleFederation()	Tests if any broker federation is exposed.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsPriceEnablerLookup()} is {@code 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 {@code supportsPriceEnablerLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPriceEnablerQuery()} is {@code 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 {@code supportsPriceEnablerQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPriceEnablerSearch()} is {@code 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 {@code supportsPriceEnablerSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPriceEnablerAdmin()} is {@code 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 {@code supportsPriceEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPriceEnablerNotification()} is {@code 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 {@code supportsPriceEnablerNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPriceEnablerStore()} is {@code 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 {@code supportsPriceEnablerStoreAssignment()} is {@code 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 {@code supportsPriceEnablerSmartStore()} is {@code 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 {@code supportsPriceEnablerPriceRuleLookup()} is {@code 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 a 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 {@code supportsPriceEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPriceEnablerRuleApplication()} is {@code 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 {@code supportsPriceEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .