org.osid.ordering

Interface OrderingProxyManager

All Superinterfaces:

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

public interface OrderingProxyManager
extends OsidProxyManager, OrderingProfile

The order manager provides access to order sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy for passing information from a server environment. The sessions included in this manager are:

• MyOrderSession: a session to lookup orders
• OrderLookupSession: a session to lookup orders
• OrderQuerySession: a session to query orders
• OrderSearchSession: a session to search orders
• OrderAdminSession: a session to manage orders
• OrderNotificationSession: a session to subscribe to notifications of order changes
• OrderStoreSession: a session to lookup order store mappings
• OrderStoreAssignmentSession: a session to manage order store mappings
• OrderSmartStoreSession: a session to manage smart stores of orders
• ItemAdminSession: a session to add items to an order
• ProductLookupSession: a session to retrieve products
• ProductQuerySession: a session to query products
• ProductSearchSession: a session to search for products
• ProductAdminSession: a session to create, update and delete products
• ProductNotificationSession: a session to receive notifications for changes in products
• ProductStoreSession: a session to lookup product store mappings
• ProductStoreAssignmentSession: a session to manage product store mappings
• ProductSmartStoreSession: a session to manage smart stores of products

• PriceScheduleLookupSession: a session to retrieve price schedules
• PriceScheduleQuerySession: a session to query price schedules
• PriceScheduleSearchSession: a session to search for price schedules
• PriceScheduleAdminSession: a session to create, update and delete price schedules
• PriceScheduleNotificationSession: a session to receive notifications for changes in price schedules
• PriceScheduleStoreSession: a session to lookup price schedule store mappings
• PriceScheduleStoreAssignmentSession: a session to manage price schedule store mappings
• PriceScheduleSmartStoreSession: a session to manage smart stores of price schedules

• StoreLookupSession: a session to retrieve stores
• StoreQuerySession: a session to query stores
• StoreSearchSession: a session to search for stores
• StoreAdminSession: a session to create, update and delete stores
• StoreNotificationSession: a session to receive notifications for changes in stores
• StoreHierarchyTraversalSession: a session to traverse hierarchies of stores
• StoreHierarchyDesignSession: a session to manage hierarchies of stores

The ordering manager also provides a profile for determing the supported search types supported by this service.

Method Summary

Methods

Modifier and Type	Method and Description
ProductStoreAssignmentSession	gerProductStoreAssignmentSession(Proxy proxy) Gets the session for assigning product to store mappings.
ItemAdminSession	getItemAdminSession(Proxy proxy) Gets the OsidSession associated with the item adminsitartive service.
ItemAdminSession	getItemAdminSessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the item admin service for the given store.
MyOrderSession	getMyOrderSession(Proxy proxy) Gets the OsidSession associated with the order lookup service for the authenticated agent.
MyOrderSession	getMyOrderSessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the order lookup service for the authenticated agent for the given store.
OrderAdminSession	getOrderAdminSession(Proxy proxy) Gets the OsidSession associated with the order administration service.
OrderAdminSession	getOrderAdminSessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the order administration service for the given store.
OrderingBatchProxyManager	getOrderingBatchProxyManager() Gets the OrderingBatchProxyManager.
OrderingRulesProxyManager	getOrderingRulesProxyManager() Gets the OrderingRulesProxyManager.
OrderLookupSession	getOrderLookupSession(Proxy proxy) Gets the OsidSession associated with the order lookup service.
OrderLookupSession	getOrderLookupSessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the order lookup service for the given store.
OrderNotificationSession	getOrderNotificationSession(OrderReceiver orderReceiver, Proxy proxy) Gets the OsidSession associated with the order notification service.
OrderNotificationSession	getOrderNotificationSessionForStore(OrderReceiver orderReceiver, Id storeId, Proxy proxy) Gets the OsidSession associated with the order notification service for the given store.
OrderQuerySession	getOrderQuerySession(Proxy proxy) Gets the OsidSession associated with the order query service.
OrderQuerySession	getOrderQuerySessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the order query service for the given store.
OrderSearchSession	getOrderSearchSession(Proxy proxy) Gets the OsidSession associated with the order search service.
OrderSearchSession	getOrderSearchSessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the order search service for the given store.
OrderSmartStoreSession	getOrderSmartStoreSession(Id storeId, Proxy proxy) Gets the session associated with the order smart store for the given store.
OrderStoreAssignmentSession	getOrderStoreAssignmentSession(Proxy proxy) Gets the session for assigning order to store mappings.
OrderStoreSession	getOrderStoreSession(Proxy proxy) Gets the session for retrieving odrer to store mappings.
PriceScheduleAdminSession	getPriceScheduleAdminSession(Proxy proxy) Gets the OsidSession associated with the price schedule administrative service.
PriceScheduleAdminSession	getPriceScheduleAdminSessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the price schedule administrative service for the given store.
PriceScheduleLookupSession	getPriceScheduleLookupSession(Proxy proxy) Gets the OsidSession associated with the price schedule lookup service.
PriceScheduleLookupSession	getPriceScheduleLookupSessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the price schedule lookup service for the given store.
PriceScheduleNotificationSession	getPriceScheduleNotificationSession(PriceScheduleReceiver priceScheduleReceiver, Proxy proxy) Gets the OsidSession associated with the price schedule notification service.
PriceScheduleNotificationSession	getPriceScheduleNotificationSessionForStore(PriceScheduleReceiver priceScheduleReceiver, Id storeId, Proxy proxy) Gets the OsidSession associated with the price schedule notification service for the given store.
PriceScheduleQuerySession	getPriceScheduleQuerySession(Proxy proxy) Gets the OsidSession associated with the price schedule query service.
PriceScheduleQuerySession	getPriceScheduleQuerySessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the price schedule query service for the given store.
PriceScheduleSearchSession	getPriceScheduleSearchSession(Proxy proxy) Gets the OsidSession associated with the price schedule search service.
PriceScheduleSearchSession	getPriceScheduleSearchSessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the price schedule search service for the given store.
PriceScheduleSmartStoreSession	getPriceScheduleSmartStoreSession(Id storeId, Proxy proxy) Gets the session associated with the price schedule smart store for the given store.
PriceScheduleStoreAssignmentSession	getPriceScheduleStoreAssignmentSession(Proxy proxy) Gets the session for assigning price schedule to store mappings.
PriceScheduleStoreSession	getPriceScheduleStoreSession(Proxy proxy) Gets the session for retrieving price schedule to store mappings.
ProductAdminSession	getProductAdminSession(Proxy proxy) Gets the OsidSession associated with the product administrative service.
ProductAdminSession	getProductAdminSessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the product administrative service for the given store.
ProductLookupSession	getProductLookupSession(Proxy proxy) Gets the OsidSession associated with the product lookup service.
ProductLookupSession	getProductLookupSessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the product lookup service for the given store.
ProductNotificationSession	getProductNotificationSession(ProductReceiver productReceiver, Proxy proxy) Gets the OsidSession associated with the product notification service.
ProductNotificationSession	getProductNotificationSessionForStore(ProductReceiver productReceiver, Id storeId, Proxy proxy) Gets the OsidSession associated with the product notification service for the given store.
ProductQuerySession	getProductQuerySession(Proxy proxy) Gets the OsidSession associated with the product query service.
ProductQuerySession	getProductQuerySessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the product query service for the given store.
ProductSearchSession	getProductSearchSession(Proxy proxy) Gets the OsidSession associated with the product search service.
ProductSearchSession	getProductSearchSessionForStore(Id storeId, Proxy proxy) Gets the OsidSession associated with the product search service for the given store.
ProductSmartStoreSession	getProductSmartStoreSession(Id storeId, Proxy proxy) Gets the session associated with the product smart store for the given store.
ProductStoreSession	getProductStoreSession(Proxy proxy) Gets the session for retrieving product to store mappings.
StoreAdminSession	getStoreAdminSession(Proxy proxy) Gets the OsidSession associated with the store administrative service.
StoreHierarchyDesignSession	getStoreHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the store hierarchy design service.
StoreHierarchySession	getStoreHierarchySession(Proxy proxy) Gets the OsidSession associated with the store hierarchy service.
StoreLookupSession	getStoreLookupSession(Proxy proxy) Gets the OsidSession associated with the store lookup service.
StoreNotificationSession	getStoreNotificationSession(StoreReceiver storeReceiver, Proxy proxy) Gets the OsidSession associated with the store notification service.
StoreQuerySession	getStoreQuerySession(Proxy proxy) Gets the OsidSession associated with the store query service.
StoreSearchSession	getStoreSearchSession(Proxy proxy) Gets the OsidSession associated with the store search service.

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.OrderingProfile

getItemRecordTypes, getItemSearchRecordTypes, getOrderRecordTypes, getOrderSearchRecordTypes, getPriceRecordTypes, getPriceScheduleRecordTypes, getPriceScheduleSearchRecordTypes, getProductRecordTypes, getProductSearchRecordTypes, getStoreRecordTypes, getStoreSearchRecordTypes, supportsItemAdmin, supportsItemRecordType, supportsItemSearchRecordType, supportsMyOrder, supportsOrderAdmin, supportsOrderingBatch, supportsOrderingRules, supportsOrderLookup, supportsOrderNotification, supportsOrderQuery, supportsOrderRecordType, supportsOrderSearch, supportsOrderSearchRecordType, supportsOrderSmartStore, supportsOrderStore, supportsOrderStoreAssignment, supportsPriceRecordType, supportsPriceScheduleAdmin, supportsPriceScheduleLookup, supportsPriceScheduleNotification, supportsPriceScheduleQuery, supportsPriceScheduleRecordType, supportsPriceScheduleSearch, supportsPriceScheduleSearchRecordType, supportsPriceScheduleSmartStore, supportsPriceScheduleStore, supportsPriceScheduleStoreAssignment, supportsProductAdmin, supportsProductLookup, supportsProductNotification, supportsProductQuery, supportsProductRecordType, supportsProductSearch, supportsProductSearchRecordType, supportsProductSmartStore, supportsProductStore, supportsProductStoreAssignment, supportsStoreAdmin, supportsStoreHierarchy, supportsStoreHierarchyDesign, supportsStoreLookup, supportsStoreNotification, supportsStoreQuery, supportsStoreRecordType, supportsStoreSearch, supportsStoreSearchRecordType, 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

getMyOrderSession

MyOrderSession getMyOrderSession(Proxy proxy)
                                 throws OperationFailedException

Gets the OsidSession associated with the order lookup service for the authenticated agent.

Parameters:

proxy - a proxy

Returns:

a My Order Session

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyOrder() is false

Compliance:

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

getMyOrderSessionForStore

MyOrderSession getMyOrderSessionForStore(Id storeId,
                                       Proxy proxy)
                                         throws NotFoundException,
                                                OperationFailedException

Gets the OsidSession associated with the order lookup service for the authenticated agent for the given store.

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a MyOrderSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyOrder() or supportsVisibleFederation() is false

Compliance:

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

getOrderLookupSession

OrderLookupSession getOrderLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the order lookup service.

Parameters:

proxy - a proxy

Returns:

an OrderLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderLookup() is false

Compliance:

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

getOrderLookupSessionForStore

OrderLookupSession getOrderLookupSessionForStore(Id storeId,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets the OsidSession associated with the order lookup service for the given store.

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

an OrderLookupSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderLookup() or supportsVisibleFederation() is false

Compliance:

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

getOrderQuerySession

OrderQuerySession getOrderQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the order query service.

Parameters:

proxy - a proxy

Returns:

an OrderQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderQuery() is false

Compliance:

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

getOrderQuerySessionForStore

OrderQuerySession getOrderQuerySessionForStore(Id storeId,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession associated with the order query service for the given store.

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

an OrderQuerySession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderQuery() or supportsVisibleFederation() is false

Compliance:

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

getOrderSearchSession

OrderSearchSession getOrderSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the order search service.

Parameters:

proxy - a proxy

Returns:

an OrderSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderSearch() is false

Compliance:

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

getOrderSearchSessionForStore

OrderSearchSession getOrderSearchSessionForStore(Id storeId,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets the OsidSession associated with the order search service for the given store.

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

an OrderSearchSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderSearch() or supportsVisibleFederation() is false

Compliance:

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

getOrderAdminSession

OrderAdminSession getOrderAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the order administration service.

Parameters:

proxy - a proxy

Returns:

an OrderAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderAdmin() is false

Compliance:

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

getOrderAdminSessionForStore

OrderAdminSession getOrderAdminSessionForStore(Id storeId,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession associated with the order administration service for the given store.

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

an OrderAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderAdmin() or supportsVisibleFederation() is false

Compliance:

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

getOrderNotificationSession

OrderNotificationSession getOrderNotificationSession(OrderReceiver orderReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the order notification service.

Parameters:

orderReceiver - the receiver

proxy - a proxy

Returns:

an OrderNotificationSession

Throws:

NullArgumentException - orderReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderNotification() is false

Compliance:

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

getOrderNotificationSessionForStore

OrderNotificationSession getOrderNotificationSessionForStore(OrderReceiver orderReceiver,
                                                           Id storeId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the order notification service for the given store.

Parameters:

orderReceiver - the receiver

storeId - the Id of the Store

proxy - a proxy

Returns:

an OrderNotificationSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - orderReceiver, storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderNotification() or supportsVisibleFederation() is false

Compliance:

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

getOrderStoreSession

OrderStoreSession getOrderStoreSession(Proxy proxy)
                                       throws OperationFailedException

Gets the session for retrieving odrer to store mappings.

Parameters:

proxy - a proxy

Returns:

an OrderStoreSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderStore() is false

Compliance:

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

getOrderStoreAssignmentSession

OrderStoreAssignmentSession getOrderStoreAssignmentSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the session for assigning order to store mappings.

Parameters:

proxy - a proxy

Returns:

an OrderStoreAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderStoreAssignment() is false

Compliance:

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

getOrderSmartStoreSession

OrderSmartStoreSession getOrderSmartStoreSession(Id storeId,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets the session associated with the order smart store for the given store.

Parameters:

storeId - the Id of the store

proxy - a proxy

Returns:

an OrderSmartStoreSession

Throws:

NotFoundException - storeId not found

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderSmartStore() is false

Compliance:

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

getItemAdminSession

ItemAdminSession getItemAdminSession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the item adminsitartive service.

Parameters:

proxy - a proxy

Returns:

an ItemAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemAdmin() is false

Compliance:

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

getItemAdminSessionForStore

ItemAdminSession getItemAdminSessionForStore(Id storeId,
                                           Proxy proxy)
                                             throws NotFoundException,
                                                    OperationFailedException

Gets the OsidSession associated with the item admin service for the given store.

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

an ItemAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemAdmin() or supportsVisibleFederation() is false

Compliance:

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

getProductLookupSession

ProductLookupSession getProductLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the product lookup service.

Parameters:

proxy - a proxy

Returns:

a ProductLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductLookup() is false

Compliance:

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

getProductLookupSessionForStore

ProductLookupSession getProductLookupSessionForStore(Id storeId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the product lookup service for the given store.

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a ProductLookupSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductLookup() or supportsVisibleFederation() is false

Compliance:

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

getProductQuerySession

ProductQuerySession getProductQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the product query service.

Parameters:

proxy - a proxy

Returns:

a ProductQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductQuery() is false

Compliance:

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

getProductQuerySessionForStore

ProductQuerySession getProductQuerySessionForStore(Id storeId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the product query service for the given store.

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a ProductQuerySession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductQuery() or supportsVisibleFederation() is false

Compliance:

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

getProductSearchSession

ProductSearchSession getProductSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the product search service.

Parameters:

proxy - a proxy

Returns:

a ProductSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductSearch() is false

Compliance:

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

getProductSearchSessionForStore

ProductSearchSession getProductSearchSessionForStore(Id storeId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the product search service for the given store.

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a ProductSearchSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductSearch() or supportsVisibleFederation() is false

Compliance:

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

getProductAdminSession

ProductAdminSession getProductAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the product administrative service.

Parameters:

proxy - a proxy

Returns:

a ProductAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductAdmin() is false

Compliance:

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

getProductAdminSessionForStore

ProductAdminSession getProductAdminSessionForStore(Id storeId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the product administrative service for the given store.

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a ProductAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductAdmin() or supportsVisibleFederation() is false

Compliance:

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

getProductNotificationSession

ProductNotificationSession getProductNotificationSession(ProductReceiver productReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the product notification service.

Parameters:

productReceiver - the receiver

proxy - a proxy

Returns:

a ProductNotificationSession

Throws:

NullArgumentException - producteReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductNotification() is false

Compliance:

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

getProductNotificationSessionForStore

ProductNotificationSession getProductNotificationSessionForStore(ProductReceiver productReceiver,
                                                               Id storeId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the product notification service for the given store.

Parameters:

productReceiver - the receiver

storeId - the Id of the Store

proxy - a proxy

Returns:

a ProductNotificationSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - productReceiver, storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductNotification() or supportsVisibleFederation() is false

Compliance:

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

getProductStoreSession

ProductStoreSession getProductStoreSession(Proxy proxy)
                                           throws OperationFailedException

Gets the session for retrieving product to store mappings.

Parameters:

proxy - a proxy

Returns:

a ProductStoreSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductStore() is false

Compliance:

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

gerProductStoreAssignmentSession

ProductStoreAssignmentSession gerProductStoreAssignmentSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the session for assigning product to store mappings.

Parameters:

proxy - a proxy

Returns:

a ProductStoreAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductStoreAssignment() is false

Compliance:

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

getProductSmartStoreSession

ProductSmartStoreSession getProductSmartStoreSession(Id storeId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the session associated with the product smart store for the given store.

Parameters:

storeId - the Id of the store

proxy - a proxy

Returns:

a ProductSmartStoreSession

Throws:

NotFoundException - storeId not found

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductSmartStore() is false

Compliance:

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

getPriceScheduleLookupSession

PriceScheduleLookupSession getPriceScheduleLookupSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the price schedule lookup service.

Parameters:

proxy - a proxy

Returns:

a PriceScheduleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleLookup() is false

Compliance:

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

getPriceScheduleLookupSessionForStore

PriceScheduleLookupSession getPriceScheduleLookupSessionForStore(Id storeId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a PriceScheduleLookupSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleLookup() or supportsVisibleFederation() is false

Compliance:

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

getPriceScheduleQuerySession

PriceScheduleQuerySession getPriceScheduleQuerySession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the price schedule query service.

Parameters:

proxy - a proxy

Returns:

a PriceScheduleQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleQuery() is false

Compliance:

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

getPriceScheduleQuerySessionForStore

PriceScheduleQuerySession getPriceScheduleQuerySessionForStore(Id storeId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a PriceScheduleQuerySession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleQuery() or supportsVisibleFederation() is false

Compliance:

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

getPriceScheduleSearchSession

PriceScheduleSearchSession getPriceScheduleSearchSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the price schedule search service.

Parameters:

proxy - a proxy

Returns:

a PriceScheduleSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleSearch() is false

Compliance:

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

getPriceScheduleSearchSessionForStore

PriceScheduleSearchSession getPriceScheduleSearchSessionForStore(Id storeId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the price schedule search service for the given store.

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a PriceScheduleSearchSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleSearch() or supportsVisibleFederation() is false

Compliance:

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

getPriceScheduleAdminSession

PriceScheduleAdminSession getPriceScheduleAdminSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the price schedule administrative service.

Parameters:

proxy - a proxy

Returns:

a PriceScheduleAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleAdmin() is false

Compliance:

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

getPriceScheduleAdminSessionForStore

PriceScheduleAdminSession getPriceScheduleAdminSessionForStore(Id storeId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the price schedule administrative service for the given store.

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a PriceScheduleAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleAdmin() or supportsVisibleFederation() is false

Compliance:

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

getPriceScheduleNotificationSession

PriceScheduleNotificationSession getPriceScheduleNotificationSession(PriceScheduleReceiver priceScheduleReceiver,
                                                                   Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the price schedule notification service.

Parameters:

priceScheduleReceiver - the receiver

proxy - a proxy

Returns:

a PriceScheduleNotificationSession

Throws:

NullArgumentException - priceScheduleReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleNotification() is false

Compliance:

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

getPriceScheduleNotificationSessionForStore

PriceScheduleNotificationSession getPriceScheduleNotificationSessionForStore(PriceScheduleReceiver priceScheduleReceiver,
                                                                           Id storeId,
                                                                           Proxy proxy)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

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

Parameters:

priceScheduleReceiver - the receiver

storeId - the Id of the Store

proxy - a proxy

Returns:

a PriceScheduleNotificationSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - priceScheduleReceiver, storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleNotification() or supportsVisibleFederation() is false

Compliance:

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

getPriceScheduleStoreSession

PriceScheduleStoreSession getPriceScheduleStoreSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the session for retrieving price schedule to store mappings.

Parameters:

proxy - a proxy

Returns:

a PriceScheduleStoreSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleStore() is false

Compliance:

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

getPriceScheduleStoreAssignmentSession

PriceScheduleStoreAssignmentSession getPriceScheduleStoreAssignmentSession(Proxy proxy)
                                                                           throws OperationFailedException

Gets the session for assigning price schedule to store mappings.

Parameters:

proxy - a proxy

Returns:

a PriceScheduleStoreAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleStoreAssignment() is false

Compliance:

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

getPriceScheduleSmartStoreSession

PriceScheduleSmartStoreSession getPriceScheduleSmartStoreSession(Id storeId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the session associated with the price schedule smart store for the given store.

Parameters:

storeId - the Id of the store

proxy - a proxy

Returns:

a PriceScheduleSmartStoreSession

Throws:

NotFoundException - storeId not found

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleSmartStore() is false

Compliance:

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

getStoreLookupSession

StoreLookupSession getStoreLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the store lookup service.

Parameters:

proxy - a proxy

Returns:

a StoreLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStoreLookup() is false

Compliance:

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

getStoreQuerySession

StoreQuerySession getStoreQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the store query service.

Parameters:

proxy - a proxy

Returns:

a StoreQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStoreQuery() is false

Compliance:

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

getStoreSearchSession

StoreSearchSession getStoreSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the store search service.

Parameters:

proxy - a proxy

Returns:

a StoreSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStoreSearch() is false

Compliance:

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

getStoreAdminSession

StoreAdminSession getStoreAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the store administrative service.

Parameters:

proxy - a proxy

Returns:

a StoreAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStoreAdmin() is false

Compliance:

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

getStoreNotificationSession

StoreNotificationSession getStoreNotificationSession(StoreReceiver storeReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the store notification service.

Parameters:

storeReceiver - the receiver

proxy - a proxy

Returns:

a StoreNotificationSession

Throws:

NullArgumentException - storeReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStoreNotification() is false

Compliance:

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

getStoreHierarchySession

StoreHierarchySession getStoreHierarchySession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the store hierarchy service.

Parameters:

proxy - a proxy

Returns:

a StoreHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStoreHierarchy() is false

Compliance:

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

getStoreHierarchyDesignSession

StoreHierarchyDesignSession getStoreHierarchyDesignSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the store hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a StoreHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStoreHierarchyDesign() is false

Compliance:

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

getOrderingBatchProxyManager

OrderingBatchProxyManager getOrderingBatchProxyManager()
                                                       throws OperationFailedException

Gets the OrderingBatchProxyManager.

Returns:

an OrderingBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderingBatch() is false

Compliance:

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

getOrderingRulesProxyManager

OrderingRulesProxyManager getOrderingRulesProxyManager()
                                                       throws OperationFailedException

Gets the OrderingRulesProxyManager.

Returns:

an OrderingRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderingRules() is false

Compliance:

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