OSID Logo
OSID Specifications
billing batch package
Version 3.1.0
Interfaceosid.billing.batch.BillingBatchManager
Implementsosid.OsidManager
osid.billing.batch.BillingBatchProfile
Used Byosid.billing.BillingManager
Description

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

Gets the OsidSession associated with the bulk customer administration service.

Returnosid.billing.batch.CustomerBatchAdminSession a CustomerBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCustomerBatchAdmin() is false
Complianceoptional This 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.IdbusinessId the Id of the Business
Returnosid.billing.batch.CustomerBatchAdminSession a CustomerBatchAdminSession
ErrorsNOT_FOUND no Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCustomerBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCustomerBatchAdmin() and supportsVisibleFederation() are true
MethodgetItemBatchAdminSession
Description

Gets the OsidSession associated with the bulk item administration service.

Returnosid.billing.batch.ItemBatchAdminSession an ItemBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsItemBatchAdmin() is false
Complianceoptional This 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.IdbusinessId the Id of the Business
Returnosid.billing.batch.ItemBatchAdminSession an ItemBatchAdminSession
ErrorsNOT_FOUND no Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsItemBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsItemBatchAdmin() and supportsVisibleFederation() are true
MethodgetEntryBatchAdminSession
Description

Gets the OsidSession associated with the bulk entry administration service.

Returnosid.billing.batch.EntryBatchAdminSession an EntryBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryBatchAdmin() is false
Complianceoptional This 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.IdbusinessId the Id of the Business
Returnosid.billing.batch.EntryBatchAdminSession an EntryBatchAdminSession
ErrorsNOT_FOUND no Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsEntryBatchAdmin() and supportsVisibleFederation() are true
MethodgetCategoryBatchAdminSession
Description

Gets the OsidSession associated with the bulk category administration service.

Returnosid.billing.batch.CategoryBatchAdminSession a CategoryBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCategoryBatchAdmin() is false
Complianceoptional This 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.IdbusinessId the Id of the Business
Returnosid.billing.batch.CategoryBatchAdminSession a CategoryBatchAdminSession
ErrorsNOT_FOUND no Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCategoryBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCategoryBatchAdmin() and supportsVisibleFederation() are true
MethodgetPeriodBatchAdminSession
Description

Gets the OsidSession associated with the bulk period administration service.

Returnosid.billing.batch.PeriodBatchAdminSession a PeriodBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPeriodBatchAdmin() is false
Complianceoptional This 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.IdbusinessId the Id of the Business
Returnosid.billing.batch.PeriodBatchAdminSession a PeriodBatchAdminSession
ErrorsNOT_FOUND no Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPeriodBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPeriodBatchAdmin() and supportsVisibleFederation() are true
MethodgetBusinessBatchAdminSession
Description

Gets the OsidSession associated with the bulk business administration service.

Returnosid.billing.batch.BusinessBatchAdminSession a BusinessBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBusinessBatchAdmin() is false
Complianceoptional This method must be implemented if supportsBusinessBatchAdmin() is true.