Interface OrderingBatchManager

All Superinterfaces:

AutoCloseable, Closeable, OrderingBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface OrderingBatchManager
extends OsidManager, OrderingBatchProfile

The ordering batch manager provides access to ordering batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• OrderBatchAdminSession : a session to create, modify and delete orders in bulk
• ItemBatchAdminSession : a session to create, modify and delete items in bulk
• ProductBatchSession : a session to create, modify and delete products in bulk
• PriceScheduleBatchAdminSession : a session to create, modify and delete price schedules in bulk
• StoreBatchAdminSession : a session to create, modify and delete stores in bulk

Method Summary

Modifier and Type	Method	Description
ItemBatchAdminSession	getItemBatchAdminSession()	Gets the OsidSession associated with the bulk item administration service.
ItemBatchAdminSession	getItemBatchAdminSessionForStore(Id storeId)	Gets the OsidSession associated with the bulk item administration service for the given store.
OrderBatchAdminSession	getOrderBatchAdminSession()	Gets the OsidSession associated with the bulk order administration service.
OrderBatchAdminSession	getOrderBatchAdminSessionForStore(Id storeId)	Gets the OsidSession associated with the bulk order administration service for the given store.
PriceScheduleBatchAdminSession	getPriceScheduleBatchAdminSession()	Gets the OsidSession associated with the bulk price schedule administration service.
PriceScheduleBatchAdminSession	getPriceScheduleBatchAdminSessionForStore(Id storeId)	Gets the OsidSession associated with the bulk price schedule administration service for the given store.
ProductBatchAdminSession	getProductBatchAdminSession()	Gets the OsidSession associated with the bulk product administration service.
ProductBatchAdminSession	getProductBatchAdminSessionForStore(Id storeId)	Gets the OsidSession associated with the bulk product administration service for the given store.
StoreBatchAdminSession	getStoreBatchAdminSession()	Gets the OsidSession associated with the bulk store administration service.

Methods inherited from interface Closeable

close

Methods inherited from interface OrderingBatchProfile

supportsItemBatchAdmin, supportsOrderBatchAdmin, supportsPriceScheduleBatchAdmin, supportsProductBatchAdmin, supportsStoreBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsItemBatchAdmin()	Tests if bulk administration of items is available.
boolean	supportsOrderBatchAdmin()	Tests if bulk administration of orders is available.
boolean	supportsPriceScheduleBatchAdmin()	Tests if bulk administration of price schedules is available.
boolean	supportsProductBatchAdmin()	Tests if bulk administration of products is available.
boolean	supportsStoreBatchAdmin()	Tests if bulk administration of stores is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface OsidManager

close

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

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

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

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

getOrderBatchAdminSession

OrderBatchAdminSession getOrderBatchAdminSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk order administration service.

Returns:

a OrderBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsOrderBatchAdmin()} is {@code true} .

getOrderBatchAdminSessionForStore

OrderBatchAdminSession getOrderBatchAdminSessionForStore(Id storeId)
                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

storeId - the Id of the Store

Returns:

a OrderBatchAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsOrderBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getItemBatchAdminSession

ItemBatchAdminSession getItemBatchAdminSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the bulk item administration service.

Returns:

an ItemBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsItemBatchAdmin()} is {@code true} .

getItemBatchAdminSessionForStore

ItemBatchAdminSession getItemBatchAdminSessionForStore(Id storeId)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk item administration service for the given store.

Parameters:

storeId - the Id of the Store

Returns:

an ItemBatchAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsItemBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getProductBatchAdminSession

ProductBatchAdminSession getProductBatchAdminSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the bulk product administration service.

Returns:

a ProductBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProductBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsProductBatchAdmin()} is {@code true} .

getProductBatchAdminSessionForStore

ProductBatchAdminSession getProductBatchAdminSessionForStore(Id storeId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk product administration service for the given store.

Parameters:

storeId - the Id of the Store

Returns:

a ProductBatchAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProductBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getPriceScheduleBatchAdminSession

PriceScheduleBatchAdminSession getPriceScheduleBatchAdminSession()
                                                          throws OperationFailedException

Gets the OsidSession associated with the bulk price schedule administration service.

Returns:

a PriceScheduleBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsPriceScheduleBatchAdmin()} is {@code true} .

getPriceScheduleBatchAdminSessionForStore

PriceScheduleBatchAdminSession getPriceScheduleBatchAdminSessionForStore(Id storeId)
                                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

storeId - the Id of the Store

Returns:

a PriceScheduleBatchAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPriceScheduleBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getStoreBatchAdminSession

StoreBatchAdminSession getStoreBatchAdminSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk store administration service.

Returns:

a StoreBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsStoreBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsStoreBatchAdmin()} is {@code true} .