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 Modifier and Type | Method and 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. |
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the budget lookup
service.proxy
- proxy BudgetSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBudgetLookup()
is false
optional
- This method must be implemented if
supportsBudgetLookup()
is true.
BudgetLookupSession getBudgetLookupSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget lookup
service for the given business.businessId
- the Id
of the businessproxy
- proxy BudgetLookupSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- proxy
or
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the budget query
service.proxy
- proxy BudgetQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBudgetQuery()
is false
optional
- This method must be implemented if
supportsBudgetQuery()
is true.
BudgetQuerySession getBudgetQuerySessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget query
service for the given business.businessId
- the Id
of the Business
proxy
- proxy BudgetQuerySession
NotFoundException
- no business found by the given
Id
NullArgumentException
- proxy
or
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the budget search
service.proxy
- proxy BudgetSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBudgetSearch()
is false
optional
- This method must be implemented if
supportsBudgetSearch()
is true.
BudgetSearchSession getBudgetSearchSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget search
service for the given business.businessId
- the Id
of the Business
proxy
- proxy BudgetSearchSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- proxy
or
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the budget
administration service.proxy
- proxy BudgetAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBudgetAdmin()
is false
optional
- This method must be implemented if
supportsBudgetAdmin()
is true.
BudgetAdminSession getBudgetAdminSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget
administration service for the given business.businessId
- the Id
of the Business
proxy
- proxy BudgetAdminSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- proxy
or
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the budget
notification service.budgetReceiver
- the notification callbackproxy
- proxy BudgetNotificationSession
NullArgumentException
- budgetReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget
notification service for the given business.budgetReceiver
- the notification callbackbusinessId
- the Id
of the Business
proxy
- proxy BudgetNotificationSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- budgetReceiver,
businessId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
to lookup budget/catalog mappings.proxy
- proxy BudgetBusinessSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetBusiness()
is false
optional
- This method must be implemented if
supportsBudgetBusiness()
is true.
BudgetBusinessAssignmentSession getBudgetBusinessAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning budgets
to businesses.proxy
- proxy BudgetBusinessAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetBusinessAssignment()
is false
optional
- This method must be implemented if
supportsBudgetBusinessAssignment()
is true.
BudgetSmartBusinessSession getBudgetSmartBusinessSession(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget smart
business service.businessId
- the Id
of the Business
proxy
- proxy BudgetSmartBusinessSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the budget entry
lookup service.proxy
- proxy BudgetEntryLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntryLookup()
is false
optional
- This method must be implemented if
supportsBudgetEntryLookup()
is true.
BudgetEntryLookupSession getBudgetEntryLookupSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget entry
lookup service for the given business.businessId
- the Id
of the Business
proxy
- proxy BudgetEntryLookupSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- proxy
or
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the budget entry
query service.proxy
- proxy BudgetEntryQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntryQuery()
is false
optional
- This method must be implemented if
supportsBudgetEntryQuery()
is true.
BudgetEntryQuerySession getBudgetEntryQuerySessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget entry
query service for the given business.businessId
- the Id
of the Business
proxy
- proxy BudgetEntryQuerySession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the budget entry
search service.proxy
- proxy BudgetEntrySearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntrySearch()
is false
optional
- This method must be implemented if
supportsBudgetEntrySearch()
is true.
BudgetEntrySearchSession getBudgetEntrySearchSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget entry
search service for the given business.businessId
- the Id
of the Business
proxy
- proxy BudgetEntrySearchSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- proxy
or
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the budget entry
administration service.proxy
- proxy BudgetEntryAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntryAdmin()
is false
optional
- This method must be implemented if
supportsBudgetEntryAdmin()
is true.
BudgetEntryAdminSession getBudgetEntryAdminSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget entry
administration service for the given business.businessId
- the Id
of the Business
proxy
- proxy BudgetEntryAdminSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- proxy
or
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the budget entry
notification service.budgetEntryReceiver
- the notification callbackproxy
- proxy BudgetEntryNotificationSession
NullArgumentException
- budgetEntryReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget entry
notification service for the given business.budgetEntryReceiver
- the notification callbackbusinessId
- the Id
of the Business
proxy
- proxy BudgetEntryNotificationSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- budgetEntryReceiver,
businessId,
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
to lookup entry/catalog mappings.proxy
- proxy BudgetEntryCatalogSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntryCatalog()
is false
optional
- This method must be implemented if
supportsBudgetEntryCatalog()
is true.
BudgetEntryBusinessAssignmentSession getBudgetEntryBusinessAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning budget
entries to businesses.proxy
- proxy BudgetEntryCatalogAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntryCatalogAssignment()
is false
optional
- This method must be implemented if
supportsBudgetEntryCatalogAssignment()
is
true.
BudgetEntrySmartBusinessSession getBudgetEntrySmartBusinessSession(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the budget entry
smart business service.businessId
- the Id
of the Business
proxy
- proxy BudgetEntrySmartBusinessSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBudgetEntrySmartBusiness()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBudgetEntrySmartBusiness()
and
supportsVisibleFederation()
are true
FinancialsBudgetingBatchProxyManager getFinancialsBudgetingBatchProxyManager() throws OperationFailedException
FinancialsBudgetingBatchProxyManager.
FinancialsBudgetingBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFinancialsBudgetingBatch()
is false
optional
- This method must be implemented if
supportsFinancialsBudgetingBatch()
is true.