public interface FinancialsBatchManager extends OsidManager, FinancialsBatchProfile
The financials batch manager provides access to financials batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
AccountBatchAdminSession:
a session to create,
modify and delete accounts in bulk ActivityBatchAdminSession:
a session to create,
modify and delete activities in bulk FiscalPeriodBatchAdminSession:
a session to
create, modify and delete fiscal periods in bulk BusinessBatchAdminSession:
a session to create,
modify and delete businesses in bulk Modifier and Type | Method and Description |
---|---|
AccountBatchAdminSession |
getAccountBatchAdminSession()
Gets the
OsidSession associated with the bulk account
administration service. |
AccountBatchAdminSession |
getAccountBatchAdminSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the bulk account
administration service for the given business. |
ActivityBatchAdminSession |
getActivityBatchAdminSession()
Gets the
OsidSession associated with the bulk activity
administration service. |
ActivityBatchAdminSession |
getActivityBatchAdminSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the bulk activity
administration service for the given business. |
BusinessBatchAdminSession |
getBusinessBatchAdminSession()
Gets the
OsidSession associated with the bulk business
administration service. |
FiscalPeriodBatchAdminSession |
getFiscalPeriodBatchAdminSession()
Gets the
OsidSession associated with the bulk fiscal
period administration service. |
FiscalPeriodBatchAdminSession |
getFiscalPeriodBatchAdminSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the bulk fiscal
period administration service for the given business. |
changeBranch, initialize, rollbackService
close
supportsAccountBatchAdmin, supportsActivityBatchAdmin, supportsBusinessBatchAdmin, supportsFiscalPeriodBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
AccountBatchAdminSession getAccountBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk account
administration service. AccountBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAccountBatchAdmin()
is false
optional
- This method must be implemented if
supportsAccountBatchAdmin()
is true.
AccountBatchAdminSession getAccountBatchAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk account
administration service for the given business.businessId
- the Id
of the Business
AccountBatchAdminSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAccountBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAccountBatchAdmin()
and
supportsVisibleFederation()
are true
ActivityBatchAdminSession getActivityBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk activity
administration service. ActivityBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActivityBatchAdmin()
is false
optional
- This method must be implemented if
supportsActivityBatchAdmin()
is true.
ActivityBatchAdminSession getActivityBatchAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk activity
administration service for the given business.businessId
- the Id
of the Business
ActivityBatchAdminSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActivityBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsActivityBatchAdmin()
and
supportsVisibleFederation()
are true
FiscalPeriodBatchAdminSession getFiscalPeriodBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk fiscal
period administration service. FiscalPeriodBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFiscalPeriodBatchAdmin()
is false
optional
- This method must be implemented if
supportsFiscalPeriodBatchAdmin()
is true.
FiscalPeriodBatchAdminSession getFiscalPeriodBatchAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk fiscal
period administration service for the given business.businessId
- the Id
of the Business
FiscalPeriodBatchAdminSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFiscalPeriodBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsFiscalPeriodBatchAdmin()
and
supportsVisibleFederation()
are true
BusinessBatchAdminSession getBusinessBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk business
administration service. BusinessBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBusinessBatchAdmin()
is false
optional
- This method must be implemented if
supportsBusinessBatchAdmin()
is true.