Interface OrderingProxyManager

All Superinterfaces:

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

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

close

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getItemRecordTypes()	Gets the supported Item record types.
TypeList	getItemSearchRecordTypes()	Gets the supported item search record types.
TypeList	getOrderRecordTypes()	Gets the supported Order record types.
TypeList	getOrderSearchRecordTypes()	Gets the supported order search record types.
TypeList	getPriceRecordTypes()	Gets the supported Price record types.
TypeList	getPriceScheduleRecordTypes()	Gets the supported PriceSchedule record types.
TypeList	getPriceScheduleSearchRecordTypes()	Gets the supported price schedule search record types.
TypeList	getProductRecordTypes()	Gets the supported Product record types.
TypeList	getProductSearchRecordTypes()	Gets the supported product search record types.
TypeList	getStoreRecordTypes()	Gets the supported Store record types.
TypeList	getStoreSearchRecordTypes()	Gets the supported store search record types.
boolean	supportsItemAdmin()	Tests if an item admin session is available.
boolean	supportsItemRecordType(Type itemRecordType)	Tests if the given Item record type is supported.
boolean	supportsItemSearchRecordType(Type itemSearchRecordType)	Tests if the given item search record type is supported.
boolean	supportsMyOrder()	Tests for the availability of a my order lookup service.
boolean	supportsOrderAdmin()	Tests if searching for orders is available.
boolean	supportsOrderingBatch()	Tests for the availability of an ordering batch service.
boolean	supportsOrderingRules()	Tests for the availability of an ordering rules service.
boolean	supportsOrderLookup()	Tests for the availability of an order lookup service.
boolean	supportsOrderNotification()	Tests if order notification is available.
boolean	supportsOrderQuery()	Tests if querying orders is available.
boolean	supportsOrderRecordType(Type orderRecordType)	Tests if the given Order record type is supported.
boolean	supportsOrderSearch()	Tests if searching for orders is available.
boolean	supportsOrderSearchRecordType(Type orderSearchRecordType)	Tests if the given order search record type is supported.
boolean	supportsOrderSmartStore()	Tests if an order smart store session is available.
boolean	supportsOrderStore()	Tests if an order to store lookup session is available.
boolean	supportsOrderStoreAssignment()	Tests if an order to store assignment session is available.
boolean	supportsPriceRecordType(Type priceRecordType)	Tests if the given Price record type is supported.
boolean	supportsPriceScheduleAdmin()	Tests for the availability of a price schedule administrative service for creating and deleting price schedules.
boolean	supportsPriceScheduleLookup()	Tests for the availability of a price schedule lookup service.
boolean	supportsPriceScheduleNotification()	Tests for the availability of a price schedule notification service.
boolean	supportsPriceScheduleQuery()	Tests if querying price schedules is available.
boolean	supportsPriceScheduleRecordType(Type priceScheduleRecordType)	Tests if the given PriceSchedule record type is supported.
boolean	supportsPriceScheduleSearch()	Tests if searching for price schedules is available.
boolean	supportsPriceScheduleSearchRecordType(Type priceScheduleSearchRecordType)	Tests if the given price schedule search record type is supported.
boolean	supportsPriceScheduleSmartStore()	Tests if a price schedule smart store session is available.
boolean	supportsPriceScheduleStore()	Tests if a price schedule to store lookup session is available.
boolean	supportsPriceScheduleStoreAssignment()	Tests if a price schedule to store assignment session is available.
boolean	supportsProductAdmin()	Tests for the availability of a product administrative service for creating and deleting products.
boolean	supportsProductLookup()	Tests for the availability of a product lookup service.
boolean	supportsProductNotification()	Tests for the availability of a product notification service.
boolean	supportsProductQuery()	Tests if querying products is available.
boolean	supportsProductRecordType(Type productRecordType)	Tests if the given Product record type is supported.
boolean	supportsProductSearch()	Tests if searching for products is available.
boolean	supportsProductSearchRecordType(Type productSearchRecordType)	Tests if the given product search record type is supported.
boolean	supportsProductSmartStore()	Tests if a product smart store session is available.
boolean	supportsProductStore()	Tests if a product to store lookup session is available.
boolean	supportsProductStoreAssignment()	Tests if a product to store assignment session is available.
boolean	supportsStoreAdmin()	Tests for the availability of a store administrative service for creating and deleting stores.
boolean	supportsStoreHierarchy()	Tests for the availability of a store hierarchy traversal service.
boolean	supportsStoreHierarchyDesign()	Tests for the availability of a store hierarchy design service.
boolean	supportsStoreLookup()	Tests for the availability of a store lookup service.
boolean	supportsStoreNotification()	Tests for the availability of a store notification service.
boolean	supportsStoreQuery()	Tests if querying stores is available.
boolean	supportsStoreRecordType(Type storeRecordType)	Tests if the given Store record type is supported.
boolean	supportsStoreSearch()	Tests if searching for stores is available.
boolean	supportsStoreSearchRecordType(Type storeSearchRecordType)	Tests if the given store search record type is supported.
boolean	supportsVisibleFederation()	Tests if any item 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

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 {@code supportsMyOrder()} is {@code 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 {@code supportsMyOrder()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsOrderLookup()} is {@code 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 {@code supportsOrderLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsOrderQuery()} is {@code 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 {@code supportsOrderQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsOrderSearch()} is {@code 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 {@code supportsOrderSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsOrderAdmin()} is {@code 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 {@code supportsOrderAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsOrderNotification()} is {@code 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 {@code supportsOrderNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsOrderStore()} is {@code 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 {@code supportsOrderStoreAssignment()} is {@code 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 {@code supportsOrderSmartStore()} is {@code 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 {@code supportsItemAdmin()} is {@code 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 {@code supportsItemAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProductLookup()} is {@code 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 {@code supportsProductLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProductQuery()} is {@code 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 {@code supportsProductQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProductSearch()} is {@code 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 {@code supportsProductSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProductAdmin()} is {@code 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 {@code supportsProductAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProductNotification()} is {@code 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 {@code supportsProductNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProductStore()} is {@code 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 {@code supportsProductStoreAssignment()} is {@code 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 {@code supportsProductSmartStore()} is {@code 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 {@code supportsPriceScheduleLookup()} is {@code 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 {@code supportsPriceScheduleLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPriceScheduleQuery()} is {@code 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 {@code supportsPriceScheduleQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPriceScheduleSearch()} is {@code 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 {@code supportsPriceScheduleSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPriceScheduleAdmin()} is {@code 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 {@code supportsPriceScheduleAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPriceScheduleNotification()} is {@code 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 {@code supportsPriceScheduleNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPriceScheduleStore()} is {@code 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 {@code supportsPriceScheduleStoreAssignment()} is {@code 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 {@code supportsPriceScheduleSmartStore()} is {@code 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 {@code supportsStoreLookup()} is {@code 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 {@code supportsStoreQuery()} is {@code 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 {@code supportsStoreSearch()} is {@code 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 {@code supportsStoreAdmin()} is {@code 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 {@code supportsStoreNotification()} is {@code 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 {@code supportsStoreHierarchy()} is {@code 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 {@code supportsStoreHierarchyDesign()} is {@code 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 {@code supportsOrderingBatch()} is {@code 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 {@code supportsOrderingRules()} is {@code true} .