org.osid.financials.budgeting

Interface FinancialsBudgetingManager

All Superinterfaces:

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

public interface FinancialsBudgetingManager
extends OsidManager, FinancialsBudgetingProfile

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

• BudgetLookupSession: a session to retrieve budgets
• BudgetQuerySession: a session to query budgets
• BudgetSearchSession: a session to search for budgets
• BudgetAdminSession: a session to create and delete budgets
• BudgetNotificationSession: a session to receive notifications pertaining to budget changes
• BudgetBusinessSession: a session to look up budget to business mappings
• BudgetBusinessAssignmentSession: a session to manage budget to business mappings
• BudgetSmartBusinessSession: a session to manage dynamic businesses of budgets

• BudgetEntryLookupSession: a session to retrieve entries
• BudgetEntryLookupSession: a session to query entries
• BudgetEntrySearchSession: a session to search for entries
• BudgetEntryAdminSession: a session to create and delete entries
• BudgetEntryNotificationSession: a session to receive notifications pertaining to budget entry changes
• BudgetEntryBusinessSession: a session to look up budget entry to business mappings
• BudgetEntryBusinessAssignmentSession: a session to manage budget entry to business mappings
• BudgetEntrySmartBusinessAssignmentSession: a session to manage dynamic businesses of entries

Method Summary

Methods

Modifier and Type	Method and Description
BudgetAdminSession	getBudgetAdminSession() Gets the OsidSession associated with the budget administration service.
BudgetAdminSession	getBudgetAdminSessionForBusiness(Id businessId) Gets the OsidSession associated with the budget administration service for the given business.
BudgetBusinessAssignmentSession	getBudgetBusinessAssignmentSession() Gets the OsidSession associated with assigning budgets to businesses.
BudgetBusinessSession	getBudgetBusinessSession() Gets the OsidSession to lookup budget/catalog mappings.
BudgetEntryAdminSession	getBudgetEntryAdminSession() Gets the OsidSession associated with the budget entry administration service.
BudgetEntryAdminSession	getBudgetEntryAdminSessionForBusiness(Id businessId) Gets the OsidSession associated with the budget entry administration service for the given business.
BudgetEntryBusinessAssignmentSession	getBudgetEntryBusinessAssignmentSession() Gets the OsidSession associated with assigning budget entries to businesses.
BudgetEntryBusinessSession	getBudgetEntryBusinessSession() Gets the OsidSession to lookup entry/catalog mappings.
BudgetEntryLookupSession	getBudgetEntryLookupSession() Gets the OsidSession associated with the budget entry lookup service.
BudgetEntryLookupSession	getBudgetEntryLookupSessionForBusiness(Id businessId) Gets the OsidSession associated with the budget entry lookup service for the given business.
BudgetEntryNotificationSession	getBudgetEntryNotificationSession(BudgetEntryReceiver budgetEntryReceiver) Gets the OsidSession associated with the budget entry notification service.
BudgetEntryNotificationSession	getBudgetEntryNotificationSessionForBusiness(BudgetEntryReceiver budgetEntryReceiver, Id businessId) Gets the OsidSession associated with the budget entry notification service for the given business.
BudgetEntryQuerySession	getBudgetEntryQuerySession() Gets the OsidSession associated with the budget entry query service.
BudgetEntryQuerySession	getBudgetEntryQuerySessionForBusiness(Id businessId) Gets the OsidSession associated with the budget entry query service for the given business.
BudgetEntrySearchSession	getBudgetEntrySearchSession() Gets the OsidSession associated with the budget entry search service.
BudgetEntrySearchSession	getBudgetEntrySearchSessionForBusiness(Id businessId) Gets the OsidSession associated with the budget entry search service for the given business.
BudgetEntrySmartBusinessSession	getBudgetEntrySmartBusinessSession(Id businessId) Gets the OsidSession associated with the budget entry smart business service.
BudgetLookupSession	getBudgetLookupSession() Gets the OsidSession associated with the budget lookup service.
BudgetLookupSession	getBudgetLookupSessionForBusiness(Id businessId) Gets the OsidSession associated with the budget lookup service for the given business.
BudgetNotificationSession	getBudgetNotificationSession(BudgetReceiver budgetReceiver) Gets the OsidSession associated with the budget notification service.
BudgetNotificationSession	getBudgetNotificationSessionForBusiness(BudgetReceiver budgetReceiver, Id businessId) Gets the OsidSession associated with the budget notification service for the given business.
BudgetQuerySession	getBudgetQuerySession() Gets the OsidSession associated with the budget query service.
BudgetQuerySession	getBudgetQuerySessionForBusiness(Id businessId) Gets the OsidSession associated with the budget query service for the given business.
BudgetSearchSession	getBudgetSearchSession() Gets the OsidSession associated with the budget search service.
BudgetSearchSession	getBudgetSearchSessionForBusiness(Id businessId) Gets the OsidSession associated with the budget search service for the given business.
BudgetSmartBusinessSession	getBudgetSmartBusinessSession(Id businessId) Gets the OsidSession associated with the budget smart business service.
FinancialsBudgetingBatchManager	getFinancialsBudgetingBatchManager() Gets a FinancialsBudgetingBatchManager.

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.FinancialsBudgetingProfile

getBudgetEntryRecordTypes, getBudgetEntrySearchRecordTypes, getBudgetRecordTypes, getBudgetSearchRecordTypes, supportsBudgetAdmin, supportsBudgetBusiness, supportsBudgetBusinessAssignment, supportsBudgetEntryAdmin, supportsBudgetEntryBusiness, supportsBudgetEntryBusinessAssignment, supportsBudgetEntryLookup, supportsBudgetEntryNotification, supportsBudgetEntryQuery, supportsBudgetEntryRecordType, supportsBudgetEntrySearch, supportsBudgetEntrySearchRecordType, supportsBudgetEntrySmartBusiness, supportsBudgetLookup, supportsBudgetNotification, supportsBudgetQuery, supportsBudgetRecordType, supportsBudgetSearch, supportsBudgetSearchRecordType, supportsBudgetSmartBusiness, supportsFinancialsBudgetingBatch, 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

getBudgetLookupSession

BudgetLookupSession getBudgetLookupSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the budget lookup service.

Returns:

a BudgetSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetLookup() is false

Compliance:

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

getBudgetLookupSessionForBusiness

BudgetLookupSession getBudgetLookupSessionForBusiness(Id businessId)
                                                      throws NotFoundException,
                                                             OperationFailedException

Gets the OsidSession associated with the budget lookup service for the given business.

Parameters:

businessId - the Id of the business

Returns:

a BudgetLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetLookup() or supportsVisibleFederation() is false

Compliance:

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

getBudgetQuerySession

BudgetQuerySession getBudgetQuerySession()
                                         throws OperationFailedException

Gets the OsidSession associated with the budget query service.

Returns:

a BudgetQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetQuery() is false

Compliance:

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

getBudgetQuerySessionForBusiness

BudgetQuerySession getBudgetQuerySessionForBusiness(Id businessId)
                                                    throws NotFoundException,
                                                           OperationFailedException

Gets the OsidSession associated with the budget query service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

a BudgetQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetQuery() or supportsVisibleFederation() is false

Compliance:

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

getBudgetSearchSession

BudgetSearchSession getBudgetSearchSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the budget search service.

Returns:

a BudgetSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetSearch() is false

Compliance:

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

getBudgetSearchSessionForBusiness

BudgetSearchSession getBudgetSearchSessionForBusiness(Id businessId)
                                                      throws NotFoundException,
                                                             OperationFailedException

Gets the OsidSession associated with the budget search service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

a BudgetSearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetSearch() or supportsVisibleFederation() is false

Compliance:

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

getBudgetAdminSession

BudgetAdminSession getBudgetAdminSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the budget administration service.

Returns:

a BudgetAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetAdmin() is false

Compliance:

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

getBudgetAdminSessionForBusiness

BudgetAdminSession getBudgetAdminSessionForBusiness(Id businessId)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a BudgetAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetAdmin() or supportsVisibleFederation() is false

Compliance:

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

getBudgetNotificationSession

BudgetNotificationSession getBudgetNotificationSession(BudgetReceiver budgetReceiver)
                                                       throws OperationFailedException

Gets the OsidSession associated with the budget notification service.

Parameters:

budgetReceiver - the notification callback

Returns:

a BudgetNotificationSession

Throws:

NullArgumentException - budgetReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetNotification() is false

Compliance:

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

getBudgetNotificationSessionForBusiness

BudgetNotificationSession getBudgetNotificationSessionForBusiness(BudgetReceiver budgetReceiver,
                                                                Id businessId)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

Gets the OsidSession associated with the budget notification service for the given business.

Parameters:

budgetReceiver - the notification callback

businessId - the Id of the Business

Returns:

a BudgetNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - budgetReceiver or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetNotification() or supportsVisibleFederation() is false

Compliance:

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

getBudgetBusinessSession

BudgetBusinessSession getBudgetBusinessSession()
                                               throws OperationFailedException

Gets the OsidSession to lookup budget/catalog mappings.

Returns:

a BudgetBusinessSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetBusiness() is false

Compliance:

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

getBudgetBusinessAssignmentSession

BudgetBusinessAssignmentSession getBudgetBusinessAssignmentSession()
                                                                   throws OperationFailedException

Gets the OsidSession associated with assigning budgets to businesses.

Returns:

a BudgetBusinessAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetBusinessAssignment() is false

Compliance:

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

getBudgetSmartBusinessSession

BudgetSmartBusinessSession getBudgetSmartBusinessSession(Id businessId)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the budget smart business service.

Parameters:

businessId - the Id of the Business

Returns:

a BudgetSmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetSmartBusiness() or supportsVisibleFederation() is false

Compliance:

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

getBudgetEntryLookupSession

BudgetEntryLookupSession getBudgetEntryLookupSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the budget entry lookup service.

Returns:

a BudgetEntryLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryLookup() is false

Compliance:

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

getBudgetEntryLookupSessionForBusiness

BudgetEntryLookupSession getBudgetEntryLookupSessionForBusiness(Id businessId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a BudgetEntryLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryLookup() or supportsVisibleFederation() is false

Compliance:

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

getBudgetEntryQuerySession

BudgetEntryQuerySession getBudgetEntryQuerySession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the budget entry query service.

Returns:

a BudgetEntryQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryQuery() is false

Compliance:

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

getBudgetEntryQuerySessionForBusiness

BudgetEntryQuerySession getBudgetEntryQuerySessionForBusiness(Id businessId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a BudgetEntryQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryQuery() or supportsVisibleFederation() is false

Compliance:

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

getBudgetEntrySearchSession

BudgetEntrySearchSession getBudgetEntrySearchSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the budget entry search service.

Returns:

a BudgetEntrySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntrySearch() is false

Compliance:

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

getBudgetEntrySearchSessionForBusiness

BudgetEntrySearchSession getBudgetEntrySearchSessionForBusiness(Id businessId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a BudgetEntrySearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntrySearch() or supportsVisibleFederation() is false

Compliance:

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

getBudgetEntryAdminSession

BudgetEntryAdminSession getBudgetEntryAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the budget entry administration service.

Returns:

a BudgetEntryAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryAdmin() is false

Compliance:

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

getBudgetEntryAdminSessionForBusiness

BudgetEntryAdminSession getBudgetEntryAdminSessionForBusiness(Id businessId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a BudgetEntryAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryAdmin() or supportsVisibleFederation() is false

Compliance:

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

getBudgetEntryNotificationSession

BudgetEntryNotificationSession getBudgetEntryNotificationSession(BudgetEntryReceiver budgetEntryReceiver)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the budget entry notification service.

Parameters:

budgetEntryReceiver - the notification callback

Returns:

a BudgetEntryNotificationSession

Throws:

NullArgumentException - budgetEntryReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryNotification() is false

Compliance:

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

getBudgetEntryNotificationSessionForBusiness

BudgetEntryNotificationSession getBudgetEntryNotificationSessionForBusiness(BudgetEntryReceiver budgetEntryReceiver,
                                                                          Id businessId)
                                                                            throws NotFoundException,
                                                                                   OperationFailedException

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

Parameters:

budgetEntryReceiver - the notification callback

businessId - the Id of the Business

Returns:

a BudgetEntryNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - budgetEntryReceiver or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryNotification() or supportsVisibleFederation() is false

Compliance:

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

getBudgetEntryBusinessSession

BudgetEntryBusinessSession getBudgetEntryBusinessSession()
                                                         throws OperationFailedException

Gets the OsidSession to lookup entry/catalog mappings.

Returns:

a BudgetEntryBusinessSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryBusiness() is false

Compliance:

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

getBudgetEntryBusinessAssignmentSession

BudgetEntryBusinessAssignmentSession getBudgetEntryBusinessAssignmentSession()
                                                                             throws OperationFailedException

Gets the OsidSession associated with assigning budget entries to businesses.

Returns:

a BudgetEntryBusinessAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryBusinessAssignment() is false

Compliance:

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

getBudgetEntrySmartBusinessSession

BudgetEntrySmartBusinessSession getBudgetEntrySmartBusinessSession(Id businessId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the OsidSession associated with the budget entry smart business service.

Parameters:

businessId - the Id of the Business

Returns:

a BudgetEntrySmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntrySmartBusiness() or supportsVisibleFederation() is false

Compliance:

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

getFinancialsBudgetingBatchManager

FinancialsBudgetingBatchManager getFinancialsBudgetingBatchManager()
                                                                   throws OperationFailedException

Gets a FinancialsBudgetingBatchManager.

Returns:

a FinancialsBudgetingBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFinancialsBudgetingBatch() is false

Compliance:

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