Interface FinancialsBudgetingProxyManager

All Superinterfaces:

AutoCloseable, Closeable, FinancialsBudgetingProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface FinancialsBudgetingProxyManager
extends OsidProxyManager, FinancialsBudgetingProfile

The financials budgeting manager provides access to budgeting sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy for the purposes of passing information within a server application environment. 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

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

Methods inherited from interface Closeable

close

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getBudgetEntryRecordTypes()	Gets the supported BudgetEntry record types.
TypeList	getBudgetEntrySearchRecordTypes()	Gets the supported BudgetEntry search record types.
TypeList	getBudgetRecordTypes()	Gets the supported Budget record types.
TypeList	getBudgetSearchRecordTypes()	Gets the supported Budget search record types.
boolean	supportsBudgetAdmin()	Tests if budget administrative service is supported.
boolean	supportsBudgetBusiness()	Tests if a budget cataloging service is supported.
boolean	supportsBudgetBusinessAssignment()	Tests if a budget cataloging service is supported.
boolean	supportsBudgetEntryAdmin()	Tests if budget entry administrative service is supported.
boolean	supportsBudgetEntryBusiness()	Tests if a budget entry cataloging service is supported.
boolean	supportsBudgetEntryBusinessAssignment()	Tests if a budget entry cataloging service is supported.
boolean	supportsBudgetEntryLookup()	Tests if looking up budget entries is supported.
boolean	supportsBudgetEntryNotification()	Tests if an entry notification service is supported.
boolean	supportsBudgetEntryQuery()	Tests if querying budget entries is supported.
boolean	supportsBudgetEntryRecordType(Type budgetEntryRecordType)	Tests if the given BudgetEntry record type is supported.
boolean	supportsBudgetEntrySearch()	Tests if searching budget entries is supported.
boolean	supportsBudgetEntrySearchRecordType(Type budgetEntrySearchRecordType)	Tests if the given BudgetEntry search record type is supported.
boolean	supportsBudgetEntrySmartBusiness()	Tests if a budget entry smart business session is available.
boolean	supportsBudgetLookup()	Tests if looking up budgets is supported.
boolean	supportsBudgetNotification()	Tests if a budget notification service is supported.
boolean	supportsBudgetQuery()	Tests if querying budgets is supported.
boolean	supportsBudgetRecordType(Type budgetRecordType)	Tests if the given Budget record type is supported.
boolean	supportsBudgetSearch()	Tests if searching budgets is supported.
boolean	supportsBudgetSearchRecordType(Type budgetSearchRecordType)	Tests if the given Budget search record type is supported.
boolean	supportsBudgetSmartBusiness()	Tests if a budget smart business session is available.
boolean	supportsFinancialsBudgetingBatch()	Tests for the availability of a financials budgeting batch service.
boolean	supportsVisibleFederation()	Tests if any business federation is exposed.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getBudgetLookupSession

BudgetLookupSession getBudgetLookupSession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the budget lookup service.

Parameters:

proxy - proxy

Returns:

a BudgetSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetLookup()} is {@code true} .

getBudgetLookupSessionForBusiness

BudgetLookupSession getBudgetLookupSessionForBusiness(Id businessId,
 Proxy proxy)
                                               throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the business

proxy - proxy

Returns:

a BudgetLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetLookup()} and {@code supportsVisibleFederation()} are {@code true}

getBudgetQuerySession

BudgetQuerySession getBudgetQuerySession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the budget query service.

Parameters:

proxy - proxy

Returns:

a BudgetQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetQuery()} is {@code true} .

getBudgetQuerySessionForBusiness

BudgetQuerySession getBudgetQuerySessionForBusiness(Id businessId,
 Proxy proxy)
                                             throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a BudgetQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetQuery()} and {@code supportsVisibleFederation()} are {@code true}

getBudgetSearchSession

BudgetSearchSession getBudgetSearchSession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the budget search service.

Parameters:

proxy - proxy

Returns:

a BudgetSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetSearch()} is {@code true} .

getBudgetSearchSessionForBusiness

BudgetSearchSession getBudgetSearchSessionForBusiness(Id businessId,
 Proxy proxy)
                                               throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a BudgetSearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetSearch()} and {@code supportsVisibleFederation()} are {@code true}

getBudgetAdminSession

BudgetAdminSession getBudgetAdminSession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the budget administration service.

Parameters:

proxy - proxy

Returns:

a BudgetAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetAdmin()} is {@code true} .

getBudgetAdminSessionForBusiness

BudgetAdminSession getBudgetAdminSessionForBusiness(Id businessId,
 Proxy proxy)
                                             throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a BudgetAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getBudgetNotificationSession

BudgetNotificationSession getBudgetNotificationSession(BudgetReceiver budgetReceiver,
 Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the budget notification service.

Parameters:

budgetReceiver - the notification callback

proxy - proxy

Returns:

a BudgetNotificationSession

Throws:

NullArgumentException - budgetReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetNotification()} is {@code true} .

getBudgetNotificationSessionForBusiness

BudgetNotificationSession getBudgetNotificationSessionForBusiness(BudgetReceiver budgetReceiver,
 Id businessId,
 Proxy proxy)
                                                           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

proxy - proxy

Returns:

a BudgetNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - budgetReceiver, businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetNotification()} and {@code supportsVisibleFederation()} are {@code true}

getBudgetBusinessSession

BudgetBusinessSession getBudgetBusinessSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession to lookup budget/catalog mappings.

Parameters:

proxy - proxy

Returns:

a BudgetBusinessSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetBusiness() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetBusiness()} is {@code true} .

getBudgetBusinessAssignmentSession

BudgetBusinessAssignmentSession getBudgetBusinessAssignmentSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with assigning budgets to businesses.

Parameters:

proxy - proxy

Returns:

a BudgetBusinessAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetBusinessAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetBusinessAssignment()} is {@code true} .

getBudgetSmartBusinessSession

BudgetSmartBusinessSession getBudgetSmartBusinessSession(Id businessId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the budget smart business service.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a BudgetSmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetSmartBusiness() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetSmartBusiness()} and {@code supportsVisibleFederation()} are {@code true}

getBudgetEntryLookupSession

BudgetEntryLookupSession getBudgetEntryLookupSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the budget entry lookup service.

Parameters:

proxy - proxy

Returns:

a BudgetEntryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetEntryLookup()} is {@code true} .

getBudgetEntryLookupSessionForBusiness

BudgetEntryLookupSession getBudgetEntryLookupSessionForBusiness(Id businessId,
 Proxy proxy)
                                                         throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a BudgetEntryLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetEntryLookup()} and {@code supportsVisibleFederation()} are {@code true}

getBudgetEntryQuerySession

BudgetEntryQuerySession getBudgetEntryQuerySession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the budget entry query service.

Parameters:

proxy - proxy

Returns:

a BudgetEntryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetEntryQuery()} is {@code true} .

getBudgetEntryQuerySessionForBusiness

BudgetEntryQuerySession getBudgetEntryQuerySessionForBusiness(Id businessId,
 Proxy proxy)
                                                       throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a BudgetEntryQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetEntryQuery()} and {@code supportsVisibleFederation()} are {@code true}

getBudgetEntrySearchSession

BudgetEntrySearchSession getBudgetEntrySearchSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the budget entry search service.

Parameters:

proxy - proxy

Returns:

a BudgetEntrySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntrySearch() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetEntrySearch()} is {@code true} .

getBudgetEntrySearchSessionForBusiness

BudgetEntrySearchSession getBudgetEntrySearchSessionForBusiness(Id businessId,
 Proxy proxy)
                                                         throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a BudgetEntrySearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntrySearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetEntrySearch()} and {@code supportsVisibleFederation()} are {@code true}

getBudgetEntryAdminSession

BudgetEntryAdminSession getBudgetEntryAdminSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the budget entry administration service.

Parameters:

proxy - proxy

Returns:

a BudgetEntryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetEntryAdmin()} is {@code true} .

getBudgetEntryAdminSessionForBusiness

BudgetEntryAdminSession getBudgetEntryAdminSessionForBusiness(Id businessId,
 Proxy proxy)
                                                       throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a BudgetEntryAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetEntryAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getBudgetEntryNotificationSession

BudgetEntryNotificationSession getBudgetEntryNotificationSession(BudgetEntryReceiver budgetEntryReceiver,
 Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the budget entry notification service.

Parameters:

budgetEntryReceiver - the notification callback

proxy - proxy

Returns:

a BudgetEntryNotificationSession

Throws:

NullArgumentException - budgetEntryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetEntryNotification()} is {@code true} .

getBudgetEntryNotificationSessionForBusiness

BudgetEntryNotificationSession getBudgetEntryNotificationSessionForBusiness(BudgetEntryReceiver budgetEntryReceiver,
 Id businessId,
 Proxy proxy)
                                                                     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

proxy - proxy

Returns:

a BudgetEntryNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - budgetEntryReceiver, businessId , or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetEntryNotification()} and {@code supportsVisibleFederation()} are {@code true}

getBudgetEntryBusinessSession

BudgetEntryBusinessSession getBudgetEntryBusinessSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession to lookup entry/catalog mappings.

Parameters:

proxy - proxy

Returns:

a BudgetEntryCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryCatalog() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetEntryCatalog()} is {@code true} .

getBudgetEntryBusinessAssignmentSession

BudgetEntryBusinessAssignmentSession getBudgetEntryBusinessAssignmentSession(Proxy proxy)
                                                                      throws OperationFailedException

Gets the OsidSession associated with assigning budget entries to businesses.

Parameters:

proxy - proxy

Returns:

a BudgetEntryCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntryCatalogAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetEntryCatalogAssignment()} is {@code true} .

getBudgetEntrySmartBusinessSession

BudgetEntrySmartBusinessSession getBudgetEntrySmartBusinessSession(Id businessId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a BudgetEntrySmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBudgetEntrySmartBusiness() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBudgetEntrySmartBusiness()} and {@code supportsVisibleFederation()} are {@code true}

getFinancialsBudgetingBatchProxyManager

FinancialsBudgetingBatchProxyManager getFinancialsBudgetingBatchProxyManager()
                                                                      throws OperationFailedException

Gets a FinancialsBudgetingBatchProxyManager .

Returns:

a FinancialsBudgetingBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFinancialsBudgetingBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsFinancialsBudgetingBatch()} is {@code true} .