org.osid.financials.posting.batch

Interface FinancialsPostingBatchManager

All Superinterfaces:

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

public interface FinancialsPostingBatchManager
extends OsidManager, FinancialsPostingBatchProfile

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

• PostBatchAdminSession: a session to create, modify and delete posts in bulk
• PostEntryBatchAdminSession: a session to create, modify and delete entries in bulk

Method Summary

Methods

Modifier and Type	Method and Description
PostBatchAdminSession	getPostBatchAdminSession() Gets the OsidSession associated with the bulk post administration service.
PostBatchAdminSession	getPostBatchAdminSessionForBusiness(Id businessId) Gets the OsidSession associated with the bulk post administration service for the given business.
PostEntryBatchAdminSession	getPostEntryBatchAdminSession() Gets the OsidSession associated with the bulk post entry administration service.
PostEntryBatchAdminSession	getPostEntryBatchAdminSessionForBusiness(Id businessId) Gets the OsidSession associated with the bulk post entry 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.posting.batch.FinancialsPostingBatchProfile

supportsPostBatchAdmin, supportsPostEntryBatchAdmin, 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

getPostBatchAdminSession

PostBatchAdminSession getPostBatchAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk post administration service.

Returns:

a PostBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostBatchAdmin() is false

Compliance:

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

getPostBatchAdminSessionForBusiness

PostBatchAdminSession getPostBatchAdminSessionForBusiness(Id businessId)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a PostBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getPostEntryBatchAdminSession

PostEntryBatchAdminSession getPostEntryBatchAdminSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the bulk post entry administration service.

Returns:

a PostEntryBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntryBatchAdmin() is false

Compliance:

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

getPostEntryBatchAdminSessionForBusiness

PostEntryBatchAdminSession getPostEntryBatchAdminSessionForBusiness(Id businessId)
                                                                    throws NotFoundException,
                                                                           OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a PostEntryBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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