org.osid.financials.posting.batch

Interface FinancialsPostingBatchProxyManager

All Superinterfaces:

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

public interface FinancialsPostingBatchProxyManager
extends OsidProxyManager, FinancialsPostingBatchProfile

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

• 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(Proxy proxy) Gets the OsidSession associated with the bulk post administration service.
PostBatchAdminSession	getPostBatchAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the bulk post administration service for the given business.
PostEntryBatchAdminSession	getPostEntryBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk post entry administration service.
PostEntryBatchAdminSession	getPostEntryBatchAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the bulk post entry 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.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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk post administration service.

Parameters:

proxy - a proxy

Returns:

a PostBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

businessId - the Id of the Business

proxy - a proxy

Returns:

a PostBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

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

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

Parameters:

proxy - a proxy

Returns:

a PostEntryBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                  Proxy proxy)
                                                                    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

proxy - a proxy

Returns:

a PostEntryBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId or proxy 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