public interface BillingBatchManager extends OsidManager, BillingBatchProfile
The billing batch manager provides access to billing batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
CustomerBatchAdminSession:
a session to create,
modify and delete customers in bulk ItemBatchSession:
a session to create, modify and
delete items in bulk EntryBatchAdminSession:
a session to create,
modify and delete entries in bulk CategoryBatchAdminSession:
a session to create,
modify and delete categories in bulk PeriodBatchAdminSession:
a session to create,
modify and delete periods in bulk BusinessBatchAdminSession:
a session to create,
modify and delete businesses in bulk Modifier and Type | Method and Description |
---|---|
BusinessBatchAdminSession |
getBusinessBatchAdminSession()
Gets the
OsidSession associated with the bulk business
administration service. |
CategoryBatchAdminSession |
getCategoryBatchAdminSession()
Gets the
OsidSession associated with the bulk category
administration service. |
CategoryBatchAdminSession |
getCategoryBatchAdminSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the bulk category
administration service for the given business. |
CustomerBatchAdminSession |
getCustomerBatchAdminSession()
Gets the
OsidSession associated with the bulk customer
administration service. |
CustomerBatchAdminSession |
getCustomerBatchAdminSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the bulk customer
administration service for the given business. |
EntryBatchAdminSession |
getEntryBatchAdminSession()
Gets the
OsidSession associated with the bulk entry
administration service. |
EntryBatchAdminSession |
getEntryBatchAdminSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the bulk entry
administration service for the given business. |
ItemBatchAdminSession |
getItemBatchAdminSession()
Gets the
OsidSession associated with the bulk item
administration service. |
ItemBatchAdminSession |
getItemBatchAdminSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the bulk item
administration service for the given business |
PeriodBatchAdminSession |
getPeriodBatchAdminSession()
Gets the
OsidSession associated with the bulk period
administration service. |
PeriodBatchAdminSession |
getPeriodBatchAdminSessionForBusiness(Id businessId)
Gets the
OsidSession associated with the bulk period
administration service for the given business. |
changeBranch, initialize, rollbackService
close
supportsBusinessBatchAdmin, supportsCategoryBatchAdmin, supportsCustomerBatchAdmin, supportsEntryBatchAdmin, supportsItemBatchAdmin, supportsPeriodBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
CustomerBatchAdminSession getCustomerBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk customer
administration service. CustomerBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCustomerBatchAdmin()
is false
optional
- This method must be implemented if
supportsCustomerBatchAdmin()
is true.
CustomerBatchAdminSession getCustomerBatchAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk customer
administration service for the given business.businessId
- the Id
of the Business
CustomerBatchAdminSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCustomerBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCustomerBatchAdmin()
and
supportsVisibleFederation()
are true
ItemBatchAdminSession getItemBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk item
administration service. ItemBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsItemBatchAdmin()
is false
optional
- This method must be implemented if
supportsItemBatchAdmin()
is true.
ItemBatchAdminSession getItemBatchAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk item
administration service for the given businessbusinessId
- the Id
of the Business
ItemBatchAdminSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsItemBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsItemBatchAdmin()
and
supportsVisibleFederation()
are true
EntryBatchAdminSession getEntryBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk entry
administration service. EntryBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryBatchAdmin()
is false
optional
- This method must be implemented if
supportsEntryBatchAdmin()
is true.
EntryBatchAdminSession getEntryBatchAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk entry
administration service for the given business.businessId
- the Id
of the Business
EntryBatchAdminSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEntryBatchAdmin()
and
supportsVisibleFederation()
are true
CategoryBatchAdminSession getCategoryBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk category
administration service. CategoryBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCategoryBatchAdmin()
is false
optional
- This method must be implemented if
supportsCategoryBatchAdmin()
is true.
CategoryBatchAdminSession getCategoryBatchAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk category
administration service for the given business.businessId
- the Id
of the Business
CategoryBatchAdminSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCategoryBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCategoryBatchAdmin()
and
supportsVisibleFederation()
are true
PeriodBatchAdminSession getPeriodBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk period
administration service. PeriodBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPeriodBatchAdmin()
is false
optional
- This method must be implemented if
supportsPeriodBatchAdmin()
is true.
PeriodBatchAdminSession getPeriodBatchAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk period
administration service for the given business.businessId
- the Id
of the Business
PeriodBatchAdminSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPeriodBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPeriodBatchAdmin()
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.