org.osid.billing.batch

Interface BillingBatchProxyManager

All Superinterfaces:

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

public interface BillingBatchProxyManager
extends OsidProxyManager, BillingBatchProfile

The billing batch proxy manager provides access to billing batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

• CustomerBatchAdminSession: a session to create, modify and delete customers in bulk
• ItemBatchSession: a session to create, modify and delete items in bulk
• EntryBatchAdminSession: a session to create, modify and delete entries in bulk
• CategoryBatchAdminSession: a session to create, modify and delete categories in bulk
• PeriodBatchAdminSession: a session to create, modify and delete periods in bulk
• BusinessBatchAdminSession: a session to create, modify and delete businesses in bulk

Method Summary

Methods

Modifier and Type	Method and Description
BusinessBatchAdminSession	getBusinessBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk business administration service.
CategoryBatchAdminSession	getCategoryBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk category administration service.
CategoryBatchAdminSession	getCategoryBatchAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the bulk category administration service for the given business.
CustomerBatchAdminSession	getCustomerBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk customer administration service.
CustomerBatchAdminSession	getCustomerBatchAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the bulk customer administration service for the given business.
EntryBatchAdminSession	getEntryBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk entry administration service.
EntryBatchAdminSession	getEntryBatchAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the bulk entry administration service for the given business.
ItemBatchAdminSession	getItemBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk item administration service.
ItemBatchAdminSession	getItemBatchAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the bulk item administration service for the given business.
PeriodBatchAdminSession	getPeriodBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk period administration service.
PeriodBatchAdminSession	getPeriodBatchAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the bulk period administration service for the given business.

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.billing.batch.BillingBatchProfile

supportsBusinessBatchAdmin, supportsCategoryBatchAdmin, supportsCustomerBatchAdmin, supportsEntryBatchAdmin, supportsItemBatchAdmin, supportsPeriodBatchAdmin, 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

getCustomerBatchAdminSession

CustomerBatchAdminSession getCustomerBatchAdminSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk customer administration service.

Parameters:

proxy - a proxy

Returns:

a CustomerBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerBatchAdmin() is false

Compliance:

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

getCustomerBatchAdminSessionForBusiness

CustomerBatchAdminSession getCustomerBatchAdminSessionForBusiness(Id businessId,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

Gets the OsidSession associated with the bulk customer administration service for the given business.

Parameters:

businessId - the Id of the Business

proxy - a proxy

Returns:

a CustomerBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getItemBatchAdminSession

ItemBatchAdminSession getItemBatchAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk item administration service.

Parameters:

proxy - a proxy

Returns:

an ItemBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBatchAdmin() is false

Compliance:

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

getItemBatchAdminSessionForBusiness

ItemBatchAdminSession getItemBatchAdminSessionForBusiness(Id businessId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - a proxy

Returns:

an ItemBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getEntryBatchAdminSession

EntryBatchAdminSession getEntryBatchAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk entry administration service.

Parameters:

proxy - a proxy

Returns:

an EntryBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryBatchAdmin() is false

Compliance:

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

getEntryBatchAdminSessionForBusiness

EntryBatchAdminSession getEntryBatchAdminSessionForBusiness(Id businessId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

Gets the OsidSession associated with the bulk entry administration service for the given business.

Parameters:

businessId - the Id of the Business

proxy - a proxy

Returns:

an EntryBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCategoryBatchAdminSession

CategoryBatchAdminSession getCategoryBatchAdminSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk category administration service.

Parameters:

proxy - a proxy

Returns:

a CategoryBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryBatchAdmin() is false

Compliance:

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

getCategoryBatchAdminSessionForBusiness

CategoryBatchAdminSession getCategoryBatchAdminSessionForBusiness(Id businessId,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

Gets the OsidSession associated with the bulk category administration service for the given business.

Parameters:

businessId - the Id of the Business

proxy - a proxy

Returns:

a CategoryBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getPeriodBatchAdminSession

PeriodBatchAdminSession getPeriodBatchAdminSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk period administration service.

Parameters:

proxy - a proxy

Returns:

a PeriodBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodBatchAdmin() is false

Compliance:

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

getPeriodBatchAdminSessionForBusiness

PeriodBatchAdminSession getPeriodBatchAdminSessionForBusiness(Id businessId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the bulk period administration service for the given business.

Parameters:

businessId - the Id of the Business

proxy - a proxy

Returns:

a PeriodBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getBusinessBatchAdminSession

BusinessBatchAdminSession getBusinessBatchAdminSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk business administration service.

Parameters:

proxy - a proxy

Returns:

a BusinessBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessBatchAdmin() is false

Compliance:

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