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 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. |
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
BudgetLookupSession getBudgetLookupSession() throws OperationFailedException
OsidSession
associated with the budget lookup
service. BudgetSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBudgetLookup()
is false
optional
- This method must be implemented if
supportsBudgetLookup()
is true.
BudgetLookupSession getBudgetLookupSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget lookup
service for the given business.businessId
- the Id
of the business BudgetLookupSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBudgetLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBudgetLookup()
and
supportsVisibleFederation()
are true
BudgetQuerySession getBudgetQuerySession() throws OperationFailedException
OsidSession
associated with the budget query
service. BudgetQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBudgetQuery()
is false
optional
- This method must be implemented if
supportsBudgetQuery()
is true.
BudgetQuerySession getBudgetQuerySessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget query
service for the given business.businessId
- the Id
of the Business
BudgetQuerySession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBudgetQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBudgetQuery()
and
supportsVisibleFederation()
are true
BudgetSearchSession getBudgetSearchSession() throws OperationFailedException
OsidSession
associated with the budget search
service. BudgetSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBudgetSearch()
is false
optional
- This method must be implemented if
supportsBudgetSearch()
is true.
BudgetSearchSession getBudgetSearchSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget search
service for the given business.businessId
- the Id
of the Business
BudgetSearchSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBudgetSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBudgetSearch()
and
supportsVisibleFederation()
are true
BudgetAdminSession getBudgetAdminSession() throws OperationFailedException
OsidSession
associated with the budget
administration service. BudgetAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBudgetAdmin()
is false
optional
- This method must be implemented if
supportsBudgetAdmin()
is true.
BudgetAdminSession getBudgetAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget
administration service for the given business.businessId
- the Id
of the Business
BudgetAdminSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBudgetAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBudgetAdmin()
and
supportsVisibleFederation()
are true
BudgetNotificationSession getBudgetNotificationSession(BudgetReceiver budgetReceiver) throws OperationFailedException
OsidSession
associated with the budget
notification service.budgetReceiver
- the notification callback BudgetNotificationSession
NullArgumentException
- budgetReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetNotification()
is false
optional
- This method must be implemented if
supportsBudgetNotification()
is true.
BudgetNotificationSession getBudgetNotificationSessionForBusiness(BudgetReceiver budgetReceiver, Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget
notification service for the given business.budgetReceiver
- the notification callbackbusinessId
- the Id
of the Business
BudgetNotificationSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- budgetReceiver
or businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBudgetNotification()
and
supportsVisibleFederation()
are true
BudgetBusinessSession getBudgetBusinessSession() throws OperationFailedException
OsidSession
to lookup budget/catalog mappings. BudgetBusinessSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetBusiness()
is false
optional
- This method must be implemented if
supportsBudgetBusiness()
is true.
BudgetBusinessAssignmentSession getBudgetBusinessAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning budgets
to businesses. BudgetBusinessAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetBusinessAssignment()
is false
optional
- This method must be implemented if
supportsBudgetBusinessAssignment()
is true.
BudgetSmartBusinessSession getBudgetSmartBusinessSession(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget smart
business service.businessId
- the Id
of the Business
BudgetSmartBusinessSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetSmartBusiness()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBudgetSmartBusiness()
and
supportsVisibleFederation()
are true
BudgetEntryLookupSession getBudgetEntryLookupSession() throws OperationFailedException
OsidSession
associated with the budget entry
lookup service. BudgetEntryLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntryLookup()
is false
optional
- This method must be implemented if
supportsBudgetEntryLookup()
is true.
BudgetEntryLookupSession getBudgetEntryLookupSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget entry
lookup service for the given business.businessId
- the Id
of the Business
BudgetEntryLookupSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntryLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBudgetEntryLookup()
and
supportsVisibleFederation()
are true
BudgetEntryQuerySession getBudgetEntryQuerySession() throws OperationFailedException
OsidSession
associated with the budget entry
query service. BudgetEntryQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntryQuery()
is false
optional
- This method must be implemented if
supportsBudgetEntryQuery()
is true.
BudgetEntryQuerySession getBudgetEntryQuerySessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget entry
query service for the given business.businessId
- the Id
of the Business
BudgetEntryQuerySession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntryQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBudgetEntryQuery()
and
supportsVisibleFederation()
are true
BudgetEntrySearchSession getBudgetEntrySearchSession() throws OperationFailedException
OsidSession
associated with the budget entry
search service. BudgetEntrySearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntrySearch()
is false
optional
- This method must be implemented if
supportsBudgetEntrySearch()
is true.
BudgetEntrySearchSession getBudgetEntrySearchSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget entry
search service for the given business.businessId
- the Id
of the Business
BudgetEntrySearchSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntrySearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBudgetEntrySearch()
and
supportsVisibleFederation()
are true
BudgetEntryAdminSession getBudgetEntryAdminSession() throws OperationFailedException
OsidSession
associated with the budget entry
administration service. BudgetEntryAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntryAdmin()
is false
optional
- This method must be implemented if
supportsBudgetEntryAdmin()
is true.
BudgetEntryAdminSession getBudgetEntryAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget entry
administration service for the given business.businessId
- the Id
of the Business
BudgetEntryAdminSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntryAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBudgetEntryAdmin()
and
supportsVisibleFederation()
are true
BudgetEntryNotificationSession getBudgetEntryNotificationSession(BudgetEntryReceiver budgetEntryReceiver) throws OperationFailedException
OsidSession
associated with the budget entry
notification service.budgetEntryReceiver
- the notification callback BudgetEntryNotificationSession
NullArgumentException
- budgetEntryReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntryNotification()
is false
optional
- This method must be implemented if
supportsBudgetEntryNotification()
is true.
BudgetEntryNotificationSession getBudgetEntryNotificationSessionForBusiness(BudgetEntryReceiver budgetEntryReceiver, Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget entry
notification service for the given business.budgetEntryReceiver
- the notification callbackbusinessId
- the Id
of the Business
BudgetEntryNotificationSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- budgetEntryReceiver
or businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntryNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBudgetEntryNotification()
and
supportsVisibleFederation()
are true
BudgetEntryBusinessSession getBudgetEntryBusinessSession() throws OperationFailedException
OsidSession
to lookup entry/catalog mappings. BudgetEntryBusinessSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntryBusiness()
is false
optional
- This method must be implemented if
supportsBudgetEntryBusiness()
is true.
BudgetEntryBusinessAssignmentSession getBudgetEntryBusinessAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning budget
entries to businesses. BudgetEntryBusinessAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntryBusinessAssignment()
is
false
optional
- This method must be implemented if
supportsBudgetEntryBusinessAssignment()
is
true.
BudgetEntrySmartBusinessSession getBudgetEntrySmartBusinessSession(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget entry
smart business service.businessId
- the Id
of the Business
BudgetEntrySmartBusinessSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntrySmartBusiness()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBudgetEntrySmartBusiness()
and
supportsVisibleFederation()
are true
FinancialsBudgetingBatchManager getFinancialsBudgetingBatchManager() throws OperationFailedException
FinancialsBudgetingBatchManager.
FinancialsBudgetingBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFinancialsBudgetingBatch()
is false
optional
- This method must be implemented if
supportsFinancialsBudgetingBatch()
is true.