OSID Logo
OSID Specifications
billing batch package
Version 3.0.0
Interfaceosid.billing.batch.BillingBatchProxyManager
Implementsosid.OsidProxyManager
osid.billing.batch.BillingBatchProfile
Used Byosid.billing.BillingProxyManager
Description

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
MethodgetCustomerBatchAdminSession
Description

Gets the OsidSession associated with the bulk customer administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.billing.batch.CustomerBatchAdminSessiona CustomerBatchAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCustomerBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCustomerBatchAdmin() is true .
MethodgetCustomerBatchAdminSessionForBusiness
Description

Gets the OsidSession associated with the bulk customer administration service for the given business.

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxya proxy
Returnosid.billing.batch.CustomerBatchAdminSessiona CustomerBatchAdminSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENTbusinessId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCustomerBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCustomerBatchAdmin() and supportsVisibleFederation() are true
MethodgetItemBatchAdminSession
Description

Gets the OsidSession associated with the bulk item administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.billing.batch.ItemBatchAdminSessionan ItemBatchAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsItemBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsItemBatchAdmin() is true .
MethodgetItemBatchAdminSessionForBusiness
Description

Gets the OsidSession associated with the bulk item administration service for the given business.

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxya proxy
Returnosid.billing.batch.ItemBatchAdminSessionan ItemBatchAdminSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENTbusinessId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsItemBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsItemBatchAdmin() and supportsVisibleFederation() are true
MethodgetEntryBatchAdminSession
Description

Gets the OsidSession associated with the bulk entry administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.billing.batch.EntryBatchAdminSessionan EntryBatchAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsEntryBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsEntryBatchAdmin() is true .
MethodgetEntryBatchAdminSessionForBusiness
Description

Gets the OsidSession associated with the bulk entry administration service for the given business.

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxya proxy
Returnosid.billing.batch.EntryBatchAdminSessionan EntryBatchAdminSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENTbusinessId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsEntryBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEntryBatchAdmin() and supportsVisibleFederation() are true
MethodgetCategoryBatchAdminSession
Description

Gets the OsidSession associated with the bulk category administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.billing.batch.CategoryBatchAdminSessiona CategoryBatchAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCategoryBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCategoryBatchAdmin() is true .
MethodgetCategoryBatchAdminSessionForBusiness
Description

Gets the OsidSession associated with the bulk category administration service for the given business.

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxya proxy
Returnosid.billing.batch.CategoryBatchAdminSessiona CategoryBatchAdminSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENTbusinessId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCategoryBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCategoryBatchAdmin() and supportsVisibleFederation() are true
MethodgetPeriodBatchAdminSession
Description

Gets the OsidSession associated with the bulk period administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.billing.batch.PeriodBatchAdminSessiona PeriodBatchAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPeriodBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPeriodBatchAdmin() is true .
MethodgetPeriodBatchAdminSessionForBusiness
Description

Gets the OsidSession associated with the bulk period administration service for the given business.

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxya proxy
Returnosid.billing.batch.PeriodBatchAdminSessiona PeriodBatchAdminSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENTbusinessId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPeriodBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPeriodBatchAdmin() and supportsVisibleFederation() are true
MethodgetBusinessBatchAdminSession
Description

Gets the OsidSession associated with the bulk business administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.billing.batch.BusinessBatchAdminSessiona BusinessBatchAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBusinessBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBusinessBatchAdmin() is true .