public interface FinancialsManager extends OsidManager, FinancialsProfile
The financials manager provides access to financials sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
ReportingSession:
a session to retrieve financial
statements AccountLookupSession:
a session to retrieve
accounts AccountQuerySession:
a session to query accounts
AccountSearchSession:
a session to search for
accounts AccountAdminSession:
a session to create and
delete accounts AccountNotificationSession:
a session to receive
notifications pertaining to account changes AccountHierarchySession:
a session to traverse
account hierarchies AccountHierarchyDesignSession:
a sesion to manage
account hierarchies AccountBusinessSession:
a session to look up
account to business mappings AccountBusinessAssignmentSession:
a session to
manage account to business mappings AccountSmartBusinessSession:
a session to manage
dynamic businesses of accounts ActivityLookupSession:
a session to retrieve
activities ActivityLookupSession:
a session to query
activities ActivitySearchSession:
a session to search for
activities ActivityAdminSession:
a session to create and
delete activities ActivityNotificationSession:
a session to receive
notifications pertaining to activity changes ActivityHierarchySession:
a session to traverse
activity hierarchies ActivityHierarchyDesignSession:
a sesion to manage
activity hierarchies ActivityBusinessSession:
a session to look up
activity to business mappings ActivityBusinessAssignmentSession:
a session to
manage activity to business mappings ActivitySmartBusinessAssignmentSession:
a session
to manage dynamic businesses of activities FiscalPeriodLookupSession:
a session to retrieve
fiscal periods FiscalPeriodQuerySession:
a session to query
fiscal periods FiscalPeriodSearchSession:
a session to search for
fiscal periods FiscalPeriodAdminSession:
a session to create and
delete fiscal periods FiscalPeriodNotificationSession:
a session to
receive notifications pertaining to fiscal period changes FiscalPeriodBusinessSession:
a session to look up
fiscal periods to business mappings FiscalPeriodBusinessSession:
a session to look up
fiscal period to business mappings FiscalPeriodBusinessAssignmentSession:
a session
to manage fiscal period to business mappings FiscalPeriodSmartBusinessSession:
a session to
manage dynamic businesses of fiscal periods BusinessLookupSession:
a session to retrieve
businesses BusinessQuerySession:
a session to query
businesses BusinessSearchSession:
a session to search for
businesses BusinessAdminSession:
a session to create and
delete businesses BusinessNotificationSession:
a session to receive
notifications pertaining to business changes BusinessHierarchySession:
a session to traverse a
hierarchy of businesses BusinessHierarchyDesignSession:
a session to
manage a business hierarchy Modifier and Type | Method and Description |
---|---|
AccountAdminSession |
getAccountAdminSession()
Gets the
OsidSession associated with the account
administration service. |
AccountAdminSession |
getAccountAdminSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the account
administration service for the given business. |
AccountBusinessAssignmentSession |
getAccountBusinessAssignmentSession()
Gets the
OsidSession associated with assigning accounts
to businesses. |
AccountBusinessSession |
getAccountBusinessSession()
Gets the
OsidSession to lookup account/catalog
mappings. |
AccountHierarchyDesignSession |
getAccountHierarchyDesignSession()
Gets the session designing account hierarchies.
|
AccountHierarchyDesignSession |
getAccountHierarchyDesignSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the account
heirarchy design service for the given business. |
AccountHierarchySession |
getAccountHierarchySession()
Gets the session traversing account hierarchies.
|
AccountHierarchySession |
getAccountHierarchySessionForBusiness(Id businessId)
Gets the
OsidSession associated with the account
heirarchy traversal service for the given business. |
AccountLookupSession |
getAccountLookupSession()
Gets the
OsidSession associated with the account lookup
service. |
AccountLookupSession |
getAccountLookupSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the account lookup
service for the given business. |
AccountNotificationSession |
getAccountNotificationSession(AccountReceiver accountReceiver)
Gets the
OsidSession associated with the account
notification service. |
AccountNotificationSession |
getAccountNotificationSessionForBusiness(AccountReceiver accountReceiver,
Id businessId)
Gets the
OsidSession associated with the account
notification service for the given business. |
AccountQuerySession |
getAccountQuerySession()
Gets the
OsidSession associated with the account query
service. |
AccountQuerySession |
getAccountQuerySessionForBusiness(Id businessId)
Gets the
OsidSession associated with the account query
service for the given business. |
AccountSearchSession |
getAccountSearchSession()
Gets the
OsidSession associated with the account search
service. |
AccountSearchSession |
getAccountSearchSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the account search
service for the given business. |
AccountSmartBusinessSession |
getAccountSmartBusinessSession(Id businessId)
Gets the
OsidSession associated with the account smart
business service. |
ActivityAdminSession |
getActivityAdminSession()
Gets the
OsidSession associated with the activity
administration service. |
ActivityAdminSession |
getActivityAdminSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the activity
administration service for the given business. |
ActivityBusinessAssignmentSession |
getActivityBusinessAssignmentSession()
Gets the
OsidSession associated with assigning
activities to businesses. |
ActivityBusinessSession |
getActivityBusinessSession()
Gets the
OsidSession to lookup activity/catalog
mappings. |
ActivityHierarchyDesignSession |
getActivityHierarchyDesignSession()
Gets the session designing activity hierarchies.
|
ActivityHierarchyDesignSession |
getActivityHierarchyDesignSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the activity
heirarchy design service for the given business. |
ActivityHierarchySession |
getActivityHierarchySession()
Gets the session traversing activity hierarchies.
|
ActivityHierarchySession |
getActivityHierarchySessionForBusiness(Id businessId)
Gets the
OsidSession associated with the activity
heirarchy traversal service for the given business. |
ActivityLookupSession |
getActivityLookupSession()
Gets the
OsidSession associated with the activity
lookup service. |
ActivityLookupSession |
getActivityLookupSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the activity
lookup service for the given business. |
ActivityNotificationSession |
getActivityNotificationSession(ActivityReceiver activityReceiver)
Gets the
OsidSession associated with the activity
notification service. |
ActivityNotificationSession |
getActivityNotificationSessionForBusiness(ActivityReceiver activityReceiver,
Id businessId)
Gets the
OsidSession associated with the activity
notification service for the given business. |
ActivityQuerySession |
getActivityQuerySession()
Gets the
OsidSession associated with the activity query
service. |
ActivityQuerySession |
getActivityQuerySessionForBusiness(Id businessId)
Gets the
OsidSession associated with the activity query
service for the given business. |
ActivitySearchSession |
getActivitySearchSession()
Gets the
OsidSession associated with the activity
search service. |
ActivitySearchSession |
getActivitySearchSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the activity
search service for the given business. |
ActivitySmartBusinessSession |
getActivitySmartBusinessSession(Id businessId)
Gets the
OsidSession associated with the activity smart
business service. |
BusinessAdminSession |
getBusinessAdminSession()
Gets the
OsidSession associated with the business
administrative service. |
BusinessHierarchyDesignSession |
getBusinessHierarchyDesignSession()
Gets the
OsidSession associated with the business
hierarchy design service. |
BusinessHierarchySession |
getBusinessHierarchySession()
Gets the
OsidSession associated with the business
hierarchy service. |
BusinessLookupSession |
getBusinessLookupSession()
Gets the
OsidSession associated with the business
lookup service. |
BusinessNotificationSession |
getBusinessNotificationSession(BusinessReceiver businessReceiver)
Gets the
OsidSession associated with the business
notification service. |
BusinessQuerySession |
getBusinessQuerySession()
Gets the
OsidSession associated with the business query
service. |
BusinessSearchSession |
getBusinessSearchSession()
Gets the
OsidSession associated with the business
search service. |
FinancialsBatchManager |
getFinancialsBatchManager()
Gets the
FinancialsBatchManager. |
FinancialsBudgetingManager |
getFinancialsBudgetingManager()
Gets the
FinancialsBudgetingManager. |
FinancialsPostingManager |
getFinancialsPostingManager()
Gets the
FinancialsPostingManager. |
FiscalPeriodAdminSession |
getFiscalPeriodAdminSession()
Gets the
OsidSession associated with the fiscal period
administration service. |
FiscalPeriodAdminSession |
getFiscalPeriodAdminSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the fiscal period
administration service for the given business. |
FiscalPeriodBusinessAssignmentSession |
getFiscalPeriodBusinessAssignmentSession()
Gets the
OsidSession associated with assigning fiscal
periods to businesses. |
FiscalPeriodBusinessSession |
getFiscalPeriodBusinessSession()
Gets the
OsidSession to lookup fiscal period/catalog
mappings. |
FiscalPeriodLookupSession |
getFiscalPeriodLookupSession()
Gets the
OsidSession associated with the fiscal period
lookup service. |
FiscalPeriodLookupSession |
getFiscalPeriodLookupSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the fiscal period
lookup service for the given business. |
FiscalPeriodNotificationSession |
getFiscalPeriodNotificationSession(FiscalPeriodReceiver fiscalPeriodReceiver)
Gets the
OsidSession associated with the fiscal period
notification service. |
FiscalPeriodNotificationSession |
getFiscalPeriodNotificationSessionForBusiness(FiscalPeriodReceiver fiscalPeriodReceiver,
Id businessId)
Gets the
OsidSession associated with the fiscal period
notification service for the given business. |
FiscalPeriodQuerySession |
getFiscalPeriodQuerySession()
Gets the
OsidSession associated with the fiscal period
query service. |
FiscalPeriodQuerySession |
getFiscalPeriodQuerySessionForBusiness(Id businessId)
Gets the
OsidSession associated with the fiscal period
query service for the given business. |
FiscalPeriodSearchSession |
getFiscalPeriodSearchSession()
Gets the
OsidSession associated with the fiscal period
search service. |
FiscalPeriodSearchSession |
getFiscalPeriodSearchSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the fiscal period
search service for the given business. |
FiscalPeriodSmartBusinessSession |
getFiscalPeriodSmartBusinessSession(Id businessId)
Gets the
OsidSession associated with the fiscal period
smart business service. |
ReportingSession |
getReportingSession()
Gets the
OsidSession associated with the reporting
service. |
ReportingSession |
getReportingSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the reporting
service for the given business. |
changeBranch, initialize, rollbackService
close
getAccountRecordTypes, getAccountSearchRecordTypes, getActivityRecordTypes, getActivitySearchRecordTypes, getBusinessRecordTypes, getBusinessSearchRecordTypes, getFiscalPeriodRecordTypes, getFiscalPeriodSearchRecordTypes, getSummaryRecordTypes, supportsAccountAdmin, supportsAccountBusiness, supportsAccountBusinessAssignment, supportsAccountHierarchy, supportsAccountHierarchyDesign, supportsAccountLookup, supportsAccountNotification, supportsAccountQuery, supportsAccountRecordType, supportsAccountSearch, supportsAccountSearchRecordType, supportsAccountSmartBusiness, supportsActivityAdmin, supportsActivityBusiness, supportsActivityBusinessAssignment, supportsActivityHierarchy, supportsActivityHierarchyDesign, supportsActivityLookup, supportsActivityNotification, supportsActivityQuery, supportsActivityRecordType, supportsActivitySearch, supportsActivitySearchRecordType, supportsActivitySmartBusiness, supportsBusinessAdmin, supportsBusinessHierarchy, supportsBusinessHierarchyDesign, supportsBusinessLookup, supportsBusinessNotification, supportsBusinessQuery, supportsBusinessRecordType, supportsBusinessSearch, supportsBusinessSearchRecordType, supportsFinancialsBatch, supportsFinancialsBudgeting, supportsFinancialsPosting, supportsFiscalPeriodAdmin, supportsFiscalPeriodBusiness, supportsFiscalPeriodBusinessAssignment, supportsFiscalPeriodLookup, supportsFiscalPeriodNotification, supportsFiscalPeriodQuery, supportsFiscalPeriodRecordType, supportsFiscalPeriodSearch, supportsFiscalPeriodSearchRecordType, supportsFiscalPeriodSmartBusiness, supportsSummaryRecordType, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
ReportingSession getReportingSession() throws OperationFailedException
OsidSession
associated with the reporting
service. ReportingSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsReporting()
is false
optional
- This method must be implemented if
supportsReporting()
is true.
ReportingSession getReportingSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the reporting
service for the given business.businessId
- the Id
of the business ReportingSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsReporting()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsReporting()
and
supportsVisibleFederation()
are true
AccountLookupSession getAccountLookupSession() throws OperationFailedException
OsidSession
associated with the account lookup
service. AccountSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAccountLookup()
is false
optional
- This method must be implemented if
supportsAccountLookup()
is true.
AccountLookupSession getAccountLookupSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the account lookup
service for the given business.businessId
- the Id
of the business AccountLookupSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAccountLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAccountLookup()
and
supportsVisibleFederation()
are true
AccountQuerySession getAccountQuerySession() throws OperationFailedException
OsidSession
associated with the account query
service. AccountQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAccountQuery()
is false
optional
- This method must be implemented if
supportsAccountQuery()
is true.
AccountQuerySession getAccountQuerySessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the account query
service for the given business.businessId
- the Id
of the Business
AccountQuerySession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAccountQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAccountQuery()
and
supportsVisibleFederation()
are true
AccountSearchSession getAccountSearchSession() throws OperationFailedException
OsidSession
associated with the account search
service. AccountSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAccountSearch()
is false
optional
- This method must be implemented if
supportsAccountSearch()
is true.
AccountSearchSession getAccountSearchSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the account search
service for the given business.businessId
- the Id
of the Business
AccountSearchSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAccountSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAccountSearch()
and
supportsVisibleFederation()
are true
AccountAdminSession getAccountAdminSession() throws OperationFailedException
OsidSession
associated with the account
administration service. AccountAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAccountAdmin()
is false
optional
- This method must be implemented if
supportsAccountAdmin()
is true.
AccountAdminSession getAccountAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the account
administration service for the given business.businessId
- the Id
of the Business
AccountAdminSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAccountAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAccountAdmin()
and
supportsVisibleFederation()
are true
AccountNotificationSession getAccountNotificationSession(AccountReceiver accountReceiver) throws OperationFailedException
OsidSession
associated with the account
notification service.accountReceiver
- the notification callback AccountNotificationSession
NullArgumentException
- accountReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAccountNotification()
is false
optional
- This method must be implemented if
supportsAccountNotification()
is true.
AccountNotificationSession getAccountNotificationSessionForBusiness(AccountReceiver accountReceiver, Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the account
notification service for the given business.accountReceiver
- the notification callbackbusinessId
- the Id
of the Business
AccountNotificationSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- accountReceiver
or businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAccountNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAccountNotification()
and
supportsVisibleFederation()
are true
AccountHierarchySession getAccountHierarchySession() throws OperationFailedException
AccountHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAccountHierarchy() is false
optional
- This method must be implemented if
supportsAccountHierarchy()
is true. AccountHierarchySession getAccountHierarchySessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the account
heirarchy traversal service for the given business.businessId
- the Id
of the business AccountHierarchySession
NotFoundException
- businessId
not foundNullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsAccountHierarchy()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAccountHierarchy()
and
supportsVisibleFederation()
are true.
AccountHierarchyDesignSession getAccountHierarchyDesignSession() throws OperationFailedException
AccountHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAccountHierarchyDesign() is false
optional
- This method must be implemented if
supportsAccountHierarchyDesign()
is true. AccountHierarchyDesignSession getAccountHierarchyDesignSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the account
heirarchy design service for the given business.businessId
- the Id
of the business AccountHierarchyDesignSession
NotFoundException
- businessId
not foundNullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsAccountHierarchyDesign()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAccountHierarchyDesign()
and
supportsVisibleFederation()
are true.
AccountBusinessSession getAccountBusinessSession() throws OperationFailedException
OsidSession
to lookup account/catalog
mappings. AccountBusinessSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAccountBusiness()
is false
optional
- This method must be implemented if
supportsAccountBusiness()
is true.
AccountBusinessAssignmentSession getAccountBusinessAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning accounts
to businesses. AccountBusinessAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAccountBusinessAssignment()
is false
optional
- This method must be implemented if
supportsAccountBusinessAssignment()
is
true.
AccountSmartBusinessSession getAccountSmartBusinessSession(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the account smart
business service.businessId
- the Id
of the Business
AccountSmartBusinessSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAccountSmartBusiness()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAccountSmartBusiness()
and
supportsVisibleFederation()
are true
ActivityLookupSession getActivityLookupSession() throws OperationFailedException
OsidSession
associated with the activity
lookup service. ActivityLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActivityLookup()
is false
optional
- This method must be implemented if
supportsActivityLookup()
is true.
ActivityLookupSession getActivityLookupSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the activity
lookup service for the given business.businessId
- the Id
of the Business
ActivityLookupSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActivityLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsActivityLookup()
and
supportsVisibleFederation()
are true
ActivityQuerySession getActivityQuerySession() throws OperationFailedException
OsidSession
associated with the activity query
service. ActivityQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsActivityQuery()
is false
optional
- This method must be implemented if
supportsActivityQuery()
is true.
ActivityQuerySession getActivityQuerySessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the activity query
service for the given business.businessId
- the Id
of the Business
ActivityQuerySession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsActivityQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsActivityQuery()
and
supportsVisibleFederation()
are true
ActivitySearchSession getActivitySearchSession() throws OperationFailedException
OsidSession
associated with the activity
search service. ActivitySearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActivitySearch()
is false
optional
- This method must be implemented if
supportsActivitySearch()
is true.
ActivitySearchSession getActivitySearchSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the activity
search service for the given business.businessId
- the Id
of the Business
ActivitySearchSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActivitySearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsActivitySearch()
and
supportsVisibleFederation()
are true
ActivityAdminSession getActivityAdminSession() throws OperationFailedException
OsidSession
associated with the activity
administration service. ActivityAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsActivityAdmin()
is false
optional
- This method must be implemented if
supportsActivityAdmin()
is true.
ActivityAdminSession getActivityAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the activity
administration service for the given business.businessId
- the Id
of the Business
ActivityAdminSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsActivityAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsActivityAdmin()
and
supportsVisibleFederation()
are true
ActivityNotificationSession getActivityNotificationSession(ActivityReceiver activityReceiver) throws OperationFailedException
OsidSession
associated with the activity
notification service.activityReceiver
- the notification callback ActivityNotificationSession
NullArgumentException
- activityReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActivityNotification()
is false
optional
- This method must be implemented if
supportsActivityNotification()
is true.
ActivityNotificationSession getActivityNotificationSessionForBusiness(ActivityReceiver activityReceiver, Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the activity
notification service for the given business.activityReceiver
- the notification callbackbusinessId
- the Id
of the Business
ActivityNotificationSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- activityReceiver
or businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActivityNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsActivityNotification()
and
supportsVisibleFederation()
are true
ActivityHierarchySession getActivityHierarchySession() throws OperationFailedException
ActivityHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActivityHierarchy() is false
optional
- This method must be implemented if
supportsActivityHierarchy()
is true. ActivityHierarchySession getActivityHierarchySessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the activity
heirarchy traversal service for the given business.businessId
- the Id
of the business ActivityHierarchySession
NotFoundException
- businessId
not foundNullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsActivityHierarchy()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsActivityHierarchy()
and
supportsVisibleFederation()
are true.
ActivityHierarchyDesignSession getActivityHierarchyDesignSession() throws OperationFailedException
ActivityHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActivityHierarchyDesign() is false
optional
- This method must be implemented if
supportsActivityHierarchyDesign()
is true. ActivityHierarchyDesignSession getActivityHierarchyDesignSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the activity
heirarchy design service for the given business.businessId
- the Id
of the business ActivityHierarchyDesignSession
NotFoundException
- businessId
not foundNullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsActivityHierarchyDesign()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsActivityHierarchyDesign()
and
supportsVisibleFederation()
are true.
ActivityBusinessSession getActivityBusinessSession() throws OperationFailedException
OsidSession
to lookup activity/catalog
mappings. ActivityBusinessSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActivityBusiness()
is false
optional
- This method must be implemented if
supportsActivityBusiness()
is true.
ActivityBusinessAssignmentSession getActivityBusinessAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning
activities to businesses. ActivityBusinessAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActivityBusinessAssignment()
is false
optional
- This method must be implemented if
supportsActivityBusinessAssignment()
is
true.
ActivitySmartBusinessSession getActivitySmartBusinessSession(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the activity smart
business service.businessId
- the Id
of the Business
ActivitySmartBusinessSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActivitySmartBusiness()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsActivitySmartBusiness()
and
supportsVisibleFederation()
are true
FiscalPeriodLookupSession getFiscalPeriodLookupSession() throws OperationFailedException
OsidSession
associated with the fiscal period
lookup service. FiscalPeriodSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFiscalPeriodLookup()
is false
optional
- This method must be implemented if
supportsFiscalPeriodLookup()
is true.
FiscalPeriodLookupSession getFiscalPeriodLookupSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the fiscal period
lookup service for the given business.businessId
- the Id
of the business FiscalPeriodLookupSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFiscalPeriodLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsFiscalPeriodLookup()
and
supportsVisibleFederation()
are true
FiscalPeriodQuerySession getFiscalPeriodQuerySession() throws OperationFailedException
OsidSession
associated with the fiscal period
query service. FiscalPeriodQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFiscalPeriodQuery()
is false
optional
- This method must be implemented if
supportsFiscalPeriodQuery()
is true.
FiscalPeriodQuerySession getFiscalPeriodQuerySessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the fiscal period
query service for the given business.businessId
- the Id
of the Business
FiscalPeriodQuerySession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFiscalPeriodQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsFiscalPeriodQuery()
and
supportsVisibleFederation()
are true
FiscalPeriodSearchSession getFiscalPeriodSearchSession() throws OperationFailedException
OsidSession
associated with the fiscal period
search service. FiscalPeriodSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFiscalPeriodSearch()
is false
optional
- This method must be implemented if
supportsFiscalPeriodSearch()
is true.
FiscalPeriodSearchSession getFiscalPeriodSearchSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the fiscal period
search service for the given business.businessId
- the Id
of the Business
FiscalPeriodSearchSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFiscalPeriodSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsFiscalPeriodSearch()
and
supportsVisibleFederation()
are true
FiscalPeriodAdminSession getFiscalPeriodAdminSession() throws OperationFailedException
OsidSession
associated with the fiscal period
administration service. FiscalPeriodAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFiscalPeriodAdmin()
is false
optional
- This method must be implemented if
supportsFiscalPeriodAdmin()
is true.
FiscalPeriodAdminSession getFiscalPeriodAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the fiscal period
administration service for the given business.businessId
- the Id
of the Business
FiscalPeriodAdminSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFiscalPeriodAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsFiscalPeriodAdmin()
and
supportsVisibleFederation()
are true
FiscalPeriodNotificationSession getFiscalPeriodNotificationSession(FiscalPeriodReceiver fiscalPeriodReceiver) throws OperationFailedException
OsidSession
associated with the fiscal period
notification service.fiscalPeriodReceiver
- the notification callback FiscalPeriodNotificationSession
NullArgumentException
- fiscalPeriodReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFiscalPeriodNotification()
is false
optional
- This method must be implemented if
supportsFiscalPeriodNotification()
is true.
FiscalPeriodNotificationSession getFiscalPeriodNotificationSessionForBusiness(FiscalPeriodReceiver fiscalPeriodReceiver, Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the fiscal period
notification service for the given business.fiscalPeriodReceiver
- the notification callbackbusinessId
- the Id
of the Business
FiscalPeriodNotificationSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- fiscalPeriodReceiver
or businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFiscalPeriodNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsFiscalPeriodNotification()
and
supportsVisibleFederation()
are true
FiscalPeriodBusinessSession getFiscalPeriodBusinessSession() throws OperationFailedException
OsidSession
to lookup fiscal period/catalog
mappings. FiscalPeriodBusinessSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFiscalPeriodBusiness()
is false
optional
- This method must be implemented if
supportsFiscalPeriodBusiness()
is true.
FiscalPeriodBusinessAssignmentSession getFiscalPeriodBusinessAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning fiscal
periods to businesses. FiscalPeriodBusinessAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFiscalPeriodBusinessAssignment()
is
false
optional
- This method must be implemented if
supportsFiscalPeriodBusinessAssignment()
is
true.
FiscalPeriodSmartBusinessSession getFiscalPeriodSmartBusinessSession(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the fiscal period
smart business service.businessId
- the Id
of the Business
FiscalPeriodSmartBusinessSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFiscalPeriodSmartBusiness()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsFiscalPeriodSmartBusiness()
and
supportsVisibleFederation()
are true
BusinessLookupSession getBusinessLookupSession() throws OperationFailedException
OsidSession
associated with the business
lookup service. BusinessLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBusinessLookup()
is false
optional
- This method must be implemented if
supportsBusinessLookup()
is true.
BusinessQuerySession getBusinessQuerySession() throws OperationFailedException
OsidSession
associated with the business query
service. BusinessQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBusinessQuery()
is false
optional
- This method must be implemented if
supportsBusinessQuery()
is true.
BusinessSearchSession getBusinessSearchSession() throws OperationFailedException
OsidSession
associated with the business
search service. BusinessSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBusinessSearch()
is false
optional
- This method must be implemented if
supportsBusinessSearch()
is true.
BusinessAdminSession getBusinessAdminSession() throws OperationFailedException
OsidSession
associated with the business
administrative service. BusinessAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBusinessAdmin()
is false
optional
- This method must be implemented if
supportsBusinessAdmin()
is true.
BusinessNotificationSession getBusinessNotificationSession(BusinessReceiver businessReceiver) throws OperationFailedException
OsidSession
associated with the business
notification service.businessReceiver
- the notification callback BusinessNotificationSession
NullArgumentException
- businessReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBusinessNotification()
is false
optional
- This method must be implemented if
supportsBusinessNotification()
is true.
BusinessHierarchySession getBusinessHierarchySession() throws OperationFailedException
OsidSession
associated with the business
hierarchy service. BusinessHierarchySession
for businessesOperationFailedException
- unable to complete requestUnimplementedException
-
supportsBusinessHierarchy()
is false
optional
- This method must be implemented if
supportsBusinessHierarchy()
is true.
BusinessHierarchyDesignSession getBusinessHierarchyDesignSession() throws OperationFailedException
OsidSession
associated with the business
hierarchy design service. HierarchyDesignSession
for businessesOperationFailedException
- unable to complete requestUnimplementedException
-
supportsBusinessHierarchyDesign()
is false
optional
- This method must be implemented if
supportsBusinessHierarchyDesign()
is true.
FinancialsBatchManager getFinancialsBatchManager() throws OperationFailedException
FinancialsBatchManager.
FinancialsBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFinancialsBatch()
is false
optional
- This method must be implemented if
supportsFinancialsBatch()
is true.
FinancialsBudgetingManager getFinancialsBudgetingManager() throws OperationFailedException
FinancialsBudgetingManager.
FinancialsBudgetingManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFinancialsBudgeting()
is false
optional
- This method must be implemented if
supportsFinancialsBudgeting()
is true.
FinancialsPostingManager getFinancialsPostingManager() throws OperationFailedException
FinancialsPostingManager.
FinancialsPostingManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFinancialsPosting()
is false
optional
- This method must be implemented if
supportsFinancialsPosting()
is true.