public interface BillingBatchProxyManager extends OsidProxyManager, BillingBatchProfile
The billing batch proxy manager provides access to billing batch
sessions and provides interoperability tests for various aspects of this
service. Methods in this manager support the passing of a Proxy
object. 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(Proxy proxy)
Gets the
OsidSession associated with the bulk business
administration service. |
CategoryBatchAdminSession |
getCategoryBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk category
administration service. |
CategoryBatchAdminSession |
getCategoryBatchAdminSessionForBusiness(Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the bulk category
administration service for the given business. |
CustomerBatchAdminSession |
getCustomerBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk customer
administration service. |
CustomerBatchAdminSession |
getCustomerBatchAdminSessionForBusiness(Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the bulk customer
administration service for the given business. |
EntryBatchAdminSession |
getEntryBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk entry
administration service. |
EntryBatchAdminSession |
getEntryBatchAdminSessionForBusiness(Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the bulk entry
administration service for the given business. |
ItemBatchAdminSession |
getItemBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk item
administration service. |
ItemBatchAdminSession |
getItemBatchAdminSessionForBusiness(Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the bulk item
administration service for the given business. |
PeriodBatchAdminSession |
getPeriodBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk period
administration service. |
PeriodBatchAdminSession |
getPeriodBatchAdminSessionForBusiness(Id businessId,
Proxy proxy)
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk customer
administration service.proxy
- a proxy CustomerBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCustomerBatchAdmin()
is false
optional
- This method must be implemented if
supportsCustomerBatchAdmin()
is true.
CustomerBatchAdminSession getCustomerBatchAdminSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk customer
administration service for the given business.businessId
- the Id
of the Business
proxy
- a proxy CustomerBatchAdminSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk item
administration service.proxy
- a proxy ItemBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsItemBatchAdmin()
is false
optional
- This method must be implemented if
supportsItemBatchAdmin()
is true.
ItemBatchAdminSession getItemBatchAdminSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk item
administration service for the given business.businessId
- the Id
of the Business
proxy
- a proxy ItemBatchAdminSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk entry
administration service.proxy
- a proxy EntryBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryBatchAdmin()
is false
optional
- This method must be implemented if
supportsEntryBatchAdmin()
is true.
EntryBatchAdminSession getEntryBatchAdminSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk entry
administration service for the given business.businessId
- the Id
of the Business
proxy
- a proxy EntryBatchAdminSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk category
administration service.proxy
- a proxy CategoryBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCategoryBatchAdmin()
is false
optional
- This method must be implemented if
supportsCategoryBatchAdmin()
is true.
CategoryBatchAdminSession getCategoryBatchAdminSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk category
administration service for the given business.businessId
- the Id
of the Business
proxy
- a proxy CategoryBatchAdminSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk period
administration service.proxy
- a proxy PeriodBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPeriodBatchAdmin()
is false
optional
- This method must be implemented if
supportsPeriodBatchAdmin()
is true.
PeriodBatchAdminSession getPeriodBatchAdminSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk period
administration service for the given business.businessId
- the Id
of the Business
proxy
- a proxy PeriodBatchAdminSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk business
administration service.proxy
- a proxy BusinessBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBusinessBatchAdmin()
is false
optional
- This method must be implemented if
supportsBusinessBatchAdmin()
is true.