org.osid.financials.batch

Interface FinancialsBatchProxyManager

All Superinterfaces:

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

public interface FinancialsBatchProxyManager
extends OsidProxyManager, FinancialsBatchProfile

The financials batch proxy manager provides access to financials 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:

• AccountBatchAdminSession: a session to create, modify and delete accounts in bulk
• ActivityBatchAdminSession: a session to create, modify and delete activities in bulk
• FiscalPeriodBatchAdminSession: a session to create, modify and delete fiscal periods in bulk
• BusinessBatchAdminSession: a session to create, modify and delete businesses in bulk

Method Summary

Methods

Modifier and Type	Method and Description
AccountBatchAdminSession	getAccountBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk account administration service.
AccountBatchAdminSession	getAccountBatchAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the bulk account administration service for the given business.
ActivityBatchAdminSession	getActivityBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk activity administration service.
ActivityBatchAdminSession	getActivityBatchAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the bulk activity administration service for the given business.
BusinessBatchAdminSession	getBusinessBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk business administration service.
FiscalPeriodBatchAdminSession	getFiscalPeriodBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk fiscal period administration service.
FiscalPeriodBatchAdminSession	getFiscalPeriodBatchAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the bulk fiscal 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.financials.batch.FinancialsBatchProfile

supportsAccountBatchAdmin, supportsActivityBatchAdmin, supportsBusinessBatchAdmin, supportsFiscalPeriodBatchAdmin, 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

getAccountBatchAdminSession

AccountBatchAdminSession getAccountBatchAdminSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk account administration service.

Parameters:

proxy - a proxy

Returns:

an AccountBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountBatchAdmin() is false

Compliance:

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

getAccountBatchAdminSessionForBusiness

AccountBatchAdminSession getAccountBatchAdminSessionForBusiness(Id businessId,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - a proxy

Returns:

a AccountBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getActivityBatchAdminSession

ActivityBatchAdminSession getActivityBatchAdminSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk activity administration service.

Parameters:

proxy - a proxy

Returns:

an ActivityBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBatchAdmin() is false

Compliance:

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

getActivityBatchAdminSessionForBusiness

ActivityBatchAdminSession getActivityBatchAdminSessionForBusiness(Id businessId,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - a proxy

Returns:

an ActivityBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getFiscalPeriodBatchAdminSession

FiscalPeriodBatchAdminSession getFiscalPeriodBatchAdminSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk fiscal period administration service.

Parameters:

proxy - a proxy

Returns:

a FiscalPeriodBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodBatchAdmin() is false

Compliance:

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

getFiscalPeriodBatchAdminSessionForBusiness

FiscalPeriodBatchAdminSession getFiscalPeriodBatchAdminSessionForBusiness(Id businessId,
                                                                        Proxy proxy)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - a proxy

Returns:

a FiscalPeriodBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodBatchAdmin() 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.