org.osid.financials.budgeting.batch

Interface FinancialsBudgetingBatchProxyManager

All Superinterfaces:

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

public interface FinancialsBudgetingBatchProxyManager
extends OsidProxyManager, FinancialsBudgetingBatchProfile

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

• BudgetBatchAdminSession: a session to manage budgets in bulk
• BudgetEntryBatchAdminSession: a session to manage budget entries in bulk

Method Summary

Methods

Modifier and Type	Method and Description
BudgetBatchAdminSession	getBudgetBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk budget administration service.
BudgetBatchAdminSession	getBudgetBatchAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the bulk budget administration service for the given business.
BudgetEntryBatchAdminSession	getBudgetEntryBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk budget entry administration service.
BudgetEntryBatchAdminSession	getBudgetEntryBatchAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the bulk budget 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.budgeting.batch.FinancialsBudgetingBatchProfile

supportsBudgetBatchAdmin, supportsBudgetEntryBatchAdmin, 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

getBudgetBatchAdminSession

BudgetBatchAdminSession getBudgetBatchAdminSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk budget administration service.

Parameters:

proxy - a proxy

Returns:

a BudgetBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetBatchAdmin() is false

Compliance:

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

getBudgetBatchAdminSessionForBusiness

BudgetBatchAdminSession getBudgetBatchAdminSessionForBusiness(Id businessId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - a proxy

Returns:

a BudgetBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getBudgetEntryBatchAdminSession

BudgetEntryBatchAdminSession getBudgetEntryBatchAdminSession(Proxy proxy)
                                                             throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a BudgetEntryBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryBatchAdmin() is false

Compliance:

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

getBudgetEntryBatchAdminSessionForBusiness

BudgetEntryBatchAdminSession getBudgetEntryBatchAdminSessionForBusiness(Id businessId,
                                                                      Proxy proxy)
                                                                        throws NotFoundException,
                                                                               OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - a proxy

Returns:

a BudgetEntryBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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