org.osid.financials.batch

Interface FinancialsBatchManager

All Superinterfaces:

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

public interface FinancialsBatchManager
extends OsidManager, FinancialsBatchProfile

The financials batch manager provides access to financials batch sessions and provides interoperability tests for various aspects of this service. 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() Gets the OsidSession associated with the bulk account administration service.
AccountBatchAdminSession	getAccountBatchAdminSessionForBusiness(Id businessId) Gets the OsidSession associated with the bulk account administration service for the given business.
ActivityBatchAdminSession	getActivityBatchAdminSession() Gets the OsidSession associated with the bulk activity administration service.
ActivityBatchAdminSession	getActivityBatchAdminSessionForBusiness(Id businessId) Gets the OsidSession associated with the bulk activity administration service for the given business.
BusinessBatchAdminSession	getBusinessBatchAdminSession() Gets the OsidSession associated with the bulk business administration service.
FiscalPeriodBatchAdminSession	getFiscalPeriodBatchAdminSession() Gets the OsidSession associated with the bulk fiscal period administration service.
FiscalPeriodBatchAdminSession	getFiscalPeriodBatchAdminSessionForBusiness(Id businessId) Gets the OsidSession associated with the bulk fiscal period administration service for the given business.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

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()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk account administration service.

Returns:

an AccountBatchAdminSession

Throws:

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)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

an AccountBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId 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()
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk activity administration service.

Returns:

an ActivityBatchAdminSession

Throws:

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)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

businessId - the Id of the Business

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()
                                                               throws OperationFailedException

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

Returns:

a FiscalPeriodBatchAdminSession

Throws:

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

Returns:

a FiscalPeriodBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId 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()
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk business administration service.

Returns:

a BusinessBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessBatchAdmin() is false

Compliance:

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