org.osid.financials.budgeting.batch

Interface FinancialsBudgetingBatchManager

All Superinterfaces:

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

public interface FinancialsBudgetingBatchManager
extends OsidManager, FinancialsBudgetingBatchProfile

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

• BudgetBatchAdminSession: a session to create, modify and delete budgets in bulk
• BudgetEntryBatchAdminSession: a session to create, modify and delete budget entries in bulk

Method Summary

Methods

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

Gets the OsidSession associated with the bulk budget administration service.

Returns:

a BudgetBatchAdminSession

Throws:

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

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

Parameters:

businessId - the Id of the Business

Returns:

a BudgetBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

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

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

Returns:

a BudgetEntryBatchAdminSession

Throws:

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

Returns:

a BudgetEntryBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

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