OSID Logo
OSID Specifications
billing package
Version 3.1.0
Interfaceosid.billing.BillingManager
Implementsosid.OsidManager
osid.billing.BillingProfile
Used Byosid.orchestration.OrchestrationManager
Description

The billing manager provides access to customer management sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • CustomerLookupSession: a session to retrieve customers
  • CustomerQuerySession: a session to query customers
  • CustomerSearchSession: a session to search for customers
  • CustomerAdminSession: a session to create and delete customers
  • CustomerNotificationSession: a session to receive notifications pertaining to customer changes
  • CustomerBusinessSession: a session to look up customer to business mappings
  • CustomerBusinessAssignmentSession: a session to manage customer to business mappings
  • CustomerSmartBusinessSession: a session to manage dynamic businesses of customers
  • ItemLookupSession: a session to retrieve items
  • ItemQuerySession: a session to query items
  • ItemSearchSession: a session to search for items
  • ItemAdminSession: a session to create and delete items
  • ItemNotificationSession: a session to receive notifications pertaining to item changes
  • ItemBusinessSession: a session to look up item to business mappings
  • ItemBusinessAssignmentSession: a session to manage item to business mappings
  • ItemSmartBusinessSession: a session to manage dynamic businesses of items
  • CategoryLookupSession: a session to retrieve categories
  • CategoryQuerySession: a session to query categories
  • CategorySearchSession: a session to search for categories
  • CategoryAdminSession: a session to create and delete categories
  • CategoryNotificationSession: a session to receive notifications pertaining to category changes
  • CategoryBusinessSession: a session to look up category to business mappings
  • CategoryBusinessAssignmentSession: a session to manage category to business mappings
  • CategorySmartBusinessSession: a session to manage dynamic businesses of categories
  • EntryLookupSession: a session to retrieve entries
  • EntryLookupSession: a session to query entries
  • EntrySearchSession: a session to search for entries
  • EntryAdminSession: a session to create and delete entries
  • EntryNotificationSession: a session to receive notifications pertaining to entry changes
  • EntryBusinessSession: a session to look up entry to business mappings
  • EntryBusinessAssignmentSession: a session to manage entry to business mappings
  • EntrySmartBusinessAssignmentSession: a session to manage dynamic businesses of entries
  • PeriodLookupSession: a session to retrieve periods
  • PeriodLookupSession: a session to query periods
  • PeriodSearchSession: a session to search for periods
  • PeriodAdminSession: a session to create and delete periods
  • PeriodNotificationSession: a session to receive notifications pertaining to period changes
  • PeriodBusinessSession: a session to look up period to business mappings
  • PeriodBusinessAssignmentSession: a session to manage period to business mappings
  • PeriodSmartBusinessAssignmentSession: a session to manage dynamic businesses of periods
  • BusinessLookupSession: a session to retrieve businesses
  • BusinessQuerySession: a session to query businesses
  • BusinessSearchSession: a session to search for businesses
  • BusinessAdminSession: a session to create and delete businesses
  • BusinessNotificationSession: a session to receive notifications pertaining to business changes
  • BusinessHierarchySession: a session to traverse a hierarchy of businesses
  • BusinessHierarchyDesignSession: a session to manage a business hierarchy
MethodgetCustomerLookupSession
Description

Gets the OsidSession associated with the customer lookup service.

Returnosid.billing.CustomerLookupSession a CustomerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCustomerLookup() is false
Complianceoptional This method must be implemented if supportsCustomerLookup() is true.
MethodgetCustomerLookupSessionForBusiness
Description

Gets the OsidSession associated with the customer lookup service for the given business.

Parametersosid.id.IdbusinessId the Id of the business
Returnosid.billing.CustomerLookupSession a CustomerLookupSession
ErrorsNOT_FOUND no Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCustomerLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCustomerLookup() and supportsVisibleFederation() are true
MethodgetCustomerQuerySession
Description

Gets the OsidSession associated with the customer query service.

Returnosid.billing.CustomerQuerySession a CustomerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCustomerQuery() is false
Complianceoptional This method must be implemented if supportsCustomerQuery() is true.
MethodgetCustomerQuerySessionForBusiness
Description

Gets the OsidSession associated with the customer query service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.CustomerQuerySession a CustomerQuerySession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCustomerQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCustomerQuery() and supportsVisibleFederation() are true
MethodgetCustomerSearchSession
Description

Gets the OsidSession associated with the customer search service.

Returnosid.billing.CustomerSearchSession a CustomerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCustomerSearch() is false
Complianceoptional This method must be implemented if supportsCustomerSearch() is true.
MethodgetCustomerSearchSessionForBusiness
Description

Gets the OsidSession associated with the customer search service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.CustomerSearchSession a CustomerSearchSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCustomerSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCustomerSearch() and supportsVisibleFederation() are true
MethodgetCustomerAdminSession
Description

Gets the OsidSession associated with the customer administration service.

Returnosid.billing.CustomerAdminSession a CustomerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCustomerAdmin() is false
Complianceoptional This method must be implemented if supportsCustomerAdmin() is true.
MethodgetCustomerAdminSessionForBusiness
Description

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

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.CustomerAdminSession a CustomerAdminSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCustomerAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCustomerAdmin() and supportsVisibleFederation() are true
MethodgetCustomerNotificationSession
Description

Gets the OsidSession associated with the customer notification service.

Parametersosid.billing.CustomerReceivercustomerReceiver the notification callback
Returnosid.billing.CustomerNotificationSession a CustomerNotificationSession
ErrorsNULL_ARGUMENT customerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCustomerNotification() is false
Complianceoptional This method must be implemented if supportsCustomerNotification() is true.
MethodgetCustomerNotificationSessionForBusiness
Description

Gets the OsidSession associated with the customer notification service for the given business.

Parametersosid.billing.CustomerReceivercustomerReceiver the notification callback
osid.id.IdbusinessId the Id of the Business
Returnosid.billing.CustomerNotificationSession a CustomerNotificationSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT customerReceiver or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCustomerNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCustomerNotification() and supportsVisibleFederation() are true
MethodgetCustomerBusinessSession
Description

Gets the OsidSession to lookup customer/catalog mappings.

Returnosid.billing.CustomerBusinessSession a CustomerCustomerBusinessSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCustomerBusiness() is false
Complianceoptional This method must be implemented if supportsCustomerBusiness() is true.
MethodgetCustomerBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning customers to businesses.

Returnosid.billing.CustomerBusinessAssignmentSession a CustomerBusinessAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCustomerBusinessAssignment() is false
Complianceoptional This method must be implemented if supportsCustomerBusinessAssignment() is true.
MethodgetCustomerSmartBusinessSession
Description

Gets the OsidSession associated with the customer smart business service.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.CustomerSmartBusinessSession a CustomerSmartBusinessSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCustomerSmartBusiness() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCustomerSmartBusiness() and supportsVisibleFederation() are true
MethodgetItemLookupSession
Description

Gets the OsidSession associated with the item lookup service.

Returnosid.billing.ItemLookupSession an ItemSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsItemLookup() is false
Complianceoptional This method must be implemented if supportsItemLookup() is true.
MethodgetItemLookupSessionForBusiness
Description

Gets the OsidSession associated with the item lookup service for the given business.

Parametersosid.id.IdbusinessId the Id of the business
Returnosid.billing.ItemLookupSession an ItemLookupSession
ErrorsNOT_FOUND no Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsItemLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsItemLookup() and supportsVisibleFederation() are true
MethodgetItemQuerySession
Description

Gets the OsidSession associated with the item query service.

Returnosid.billing.CustomerQuerySession an ItemQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsItemQuery() is false
Complianceoptional This method must be implemented if supportsItemQuery() is true.
MethodgetItemQuerySessionForBusiness
Description

Gets the OsidSession associated with the item query service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.CustomerQuerySession an ItemQuerySession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsItemQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsItemQuery() and supportsVisibleFederation() are true
MethodgetItemSearchSession
Description

Gets the OsidSession associated with the item search service.

Returnosid.billing.ItemSearchSession an ItemSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsItemSearch() is false
Complianceoptional This method must be implemented if supportsItemSearch() is true.
MethodgetItemSearchSessionForBusiness
Description

Gets the OsidSession associated with the item search service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.ItemSearchSession an ItemSearchSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsItemSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsItemSearch() and supportsVisibleFederation() are true
MethodgetItemAdminSession
Description

Gets the OsidSession associated with the item administration service.

Returnosid.billing.ItemAdminSession an ItemAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsItemAdmin() is false
Complianceoptional This method must be implemented if supportsItemAdmin() is true.
MethodgetItemAdminSessionForBusiness
Description

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

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.ItemAdminSession an ItemAdminSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsItemAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsItemAdmin() and supportsVisibleFederation() are true
MethodgetItemNotificationSession
Description

Gets the OsidSession associated with the item notification service.

Parametersosid.billing.ItemReceiveritemReceiver the notification callback
Returnosid.billing.ItemNotificationSession an ItemNotificationSession
ErrorsNULL_ARGUMENT itemReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsItemNotification() is false
Complianceoptional This method must be implemented if supportsItemNotification() is true.
MethodgetItemNotificationSessionForBusiness
Description

Gets the OsidSession associated with the item notification service for the given business.

Parametersosid.billing.ItemReceiveritemReceiver the notification callback
osid.id.IdbusinessId the Id of the Business
Returnosid.billing.ItemNotificationSession an ItemNotificationSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT itemReceiver or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsItemNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsItemNotification() and supportsVisibleFederation() are true
MethodgetItemBusinessSession
Description

Gets the OsidSession to lookup item/catalog mappings.

Returnosid.billing.ItemBusinessSession an ItemBusinessSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsItemBusiness() is false
Complianceoptional This method must be implemented if supportsItemBusiness() is true.
MethodgetItemBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning items to businesses.

Returnosid.billing.ItemBusinessAssignmentSession an ItemBusinessAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsItemBusinessAssignment() is false
Complianceoptional This method must be implemented if supportsItemBusinessAssignment() is true.
MethodgetItemSmartBusinessSession
Description

Gets the OsidSession associated with the item smart business service.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.ItemSmartBusinessSession an ItemSmartBusinessSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsItemSmartBusiness() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsItemSmartBusiness() and supportsVisibleFederation() are true
MethodgetCategoryLookupSession
Description

Gets the OsidSession associated with the category lookup service.

Returnosid.billing.CategoryLookupSession a CategorySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCategoryLookup() is false
Complianceoptional This method must be implemented if supportsCategoryLookup() is true.
MethodgetCategoryLookupSessionForBusiness
Description

Gets the OsidSession associated with the category lookup service for the given business.

Parametersosid.id.IdbusinessId the Id of the business
Returnosid.billing.CategoryLookupSession a CategoryLookupSession
ErrorsNOT_FOUND no Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCategoryLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCategoryLookup() and supportsVisibleFederation() are true
MethodgetCategoryQuerySession
Description

Gets the OsidSession associated with the category query service.

Returnosid.billing.CustomerQuerySession a CategoryQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCategoryQuery() is false
Complianceoptional This method must be implemented if supportsCategoryQuery() is true.
MethodgetCategoryQuerySessionForBusiness
Description

Gets the OsidSession associated with the category query service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.CustomerQuerySession a CategoryQuerySession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCategoryQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCategoryQuery() and supportsVisibleFederation() are true
MethodgetCategorySearchSession
Description

Gets the OsidSession associated with the category search service.

Returnosid.billing.CategorySearchSession a CategorySearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCategorySearch() is false
Complianceoptional This method must be implemented if supportsCategorySearch() is true.
MethodgetCategorySearchSessionForBusiness
Description

Gets the OsidSession associated with the category search service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.CategorySearchSession a CategorySearchSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCategorySearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCategorySearch() and supportsVisibleFederation() are true
MethodgetCategoryAdminSession
Description

Gets the OsidSession associated with the category administration service.

Returnosid.billing.CategoryAdminSession a CategoryAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCategoryAdmin() is false
Complianceoptional This method must be implemented if supportsCategoryAdmin() is true.
MethodgetCategoryAdminSessionForBusiness
Description

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

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.CategoryAdminSession a CategoryAdminSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCategoryAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCategoryAdmin() and supportsVisibleFederation() are true
MethodgetCategoryNotificationSession
Description

Gets the OsidSession associated with the category notification service.

Parametersosid.billing.CategoryReceivercategoryReceiver the notification callback
Returnosid.billing.CategoryNotificationSession a CategoryNotificationSession
ErrorsNULL_ARGUMENT categoryReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCategoryNotification() is false
Complianceoptional This method must be implemented if supportsCategoryNotification() is true.
MethodgetCategoryNotificationSessionForBusiness
Description

Gets the OsidSession associated with the category notification service for the given business.

Parametersosid.billing.CategoryReceivercategoryReceiver the notification callback
osid.id.IdbusinessId the Id of the Business
Returnosid.billing.CategoryNotificationSession a CategoryNotificationSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT categoryReceiver or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCategoryNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCategoryNotification() and supportsVisibleFederation() are true
MethodgetCategoryBusinessSession
Description

Gets the OsidSession to lookup category/catalog mappings.

Returnosid.billing.CategoryBusinessSession a CategoryBusinessSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCategoryBusiness() is false
Complianceoptional This method must be implemented if supportsCategoryBusiness() is true.
MethodgetCategoryBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning categories to businesses.

Returnosid.billing.CategoryBusinessAssignmentSession a CategoryBusinessAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCategoryBusinessAssignment() is false
Complianceoptional This method must be implemented if supportsCategoryBusinessAssignment() is true.
MethodgetCategorySmartBusinessSession
Description

Gets the OsidSession associated with the category smart business service.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.CategorySmartBusinessSession a CategorySmartBusinessSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCategorySmartBusiness() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCategorySmartBusiness() and supportsVisibleFederation() are true
MethodgetEntryLookupSession
Description

Gets the OsidSession associated with the entry lookup service.

Returnosid.billing.EntryLookupSession an EntryLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryLookup() is false
Complianceoptional This method must be implemented if supportsEntryLookup() is true.
MethodgetEntryLookupSessionForBusiness
Description

Gets the OsidSession associated with the entry lookup service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.EntryLookupSession an EntryLookupSession
ErrorsNOT_FOUND no Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsEntryLookup() and supportsVisibleFederation() are true
MethodgetEntryQuerySession
Description

Gets the OsidSession associated with the entry query service.

Returnosid.billing.EntryQuerySession an EntryQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryQuery() is false
Complianceoptional This method must be implemented if supportsEntryQuery() is true.
MethodgetEntryQuerySessionForBusiness
Description

Gets the OsidSession associated with the entry query service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.EntryQuerySession an EntryQuerySession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsEntryQuery() and supportsVisibleFederation() are true
MethodgetEntrySearchSession
Description

Gets the OsidSession associated with the entry search service.

Returnosid.billing.EntrySearchSession an EntrySearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntrySearch() is false
Complianceoptional This method must be implemented if supportsEntrySearch() is true.
MethodgetEntrySearchSessionForBusiness
Description

Gets the OsidSession associated with the entry search service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.EntrySearchSession an EntrySearchSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntrySearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsEntrySearch() and supportsVisibleFederation() are true
MethodgetEntryAdminSession
Description

Gets the OsidSession associated with the entry administration service.

Returnosid.billing.EntryAdminSession an EntryAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryAdmin() is false
Complianceoptional This method must be implemented if supportsEntryAdmin() is true.
MethodgetEntryAdminSessionForBusiness
Description

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

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.EntryAdminSession an EntryAdminSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsEntryAdmin() and supportsVisibleFederation() are true
MethodgetEntryNotificationSession
Description

Gets the OsidSession associated with the entry notification service.

Parametersosid.billing.EntryReceiverentryReceiver the notification callback
Returnosid.billing.EntryNotificationSession an EntryNotificationSession
ErrorsNULL_ARGUMENT entryReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryNotification() is false
Complianceoptional This method must be implemented if supportsEntryNotification() is true.
MethodgetEntryNotificationSessionForBusiness
Description

Gets the OsidSession associated with the entry notification service for the given business.

Parametersosid.billing.EntryReceiverentryReceiver the notification callback
osid.id.IdbusinessId the Id of the Business
Returnosid.billing.EntryNotificationSession an EntryNotificationSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT entryReceiver or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsEntryNotification() and supportsVisibleFederation() are true
MethodgetEntryBusinessSession
Description

Gets the OsidSession to lookup entry/catalog mappings.

Returnosid.billing.EntryBusinessSession an EntryBusinessSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryBusiness() is false
Complianceoptional This method must be implemented if supportsEntryBusiness() is true.
MethodgetEntryBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning entries to businesses.

Returnosid.billing.EntryBusinessAssignmentSession an EntryBusinessAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryBusinessAssignment() is false
Complianceoptional This method must be implemented if supportsEntryBusinessAssignment() is true.
MethodgetEntrySmartBusinessSession
Description

Gets the OsidSession associated with the entry smart business service.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.EntrySmartBusinessSession an EntrySmartBusinessSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntrySmartBusiness() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsEntrySmartBusiness() and supportsVisibleFederation() are true
MethodgetPeriodLookupSession
Description

Gets the OsidSession associated with the period lookup service.

Returnosid.billing.PeriodLookupSession a PeriodLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPeriodLookup() is false
Complianceoptional This method must be implemented if supportsPeriodLookup() is true.
MethodgetPeriodLookupSessionForBusiness
Description

Gets the OsidSession associated with the period lookup service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.PeriodLookupSession a PeriodLookupSession
ErrorsNOT_FOUND no Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPeriodLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPeriodLookup() and supportsVisibleFederation() are true
MethodgetPeriodQuerySession
Description

Gets the OsidSession associated with the period query service.

Returnosid.billing.PeriodQuerySession a PeriodQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPeriodQuery() is false
Complianceoptional This method must be implemented if supportsPeriodQuery() is true.
MethodgetPeriodQuerySessionForBusiness
Description

Gets the OsidSession associated with the period query service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.PeriodQuerySession a PeriodQuerySession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPeriodQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPeriodQuery() and supportsVisibleFederation() are true
MethodgetPeriodSearchSession
Description

Gets the OsidSession associated with the period search service.

Returnosid.billing.PeriodSearchSession a PeriodSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPeriodSearch() is false
Complianceoptional This method must be implemented if supportsPeriodSearch() is true.
MethodgetPeriodSearchSessionForBusiness
Description

Gets the OsidSession associated with the period search service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.PeriodSearchSession a PeriodSearchSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPeriodSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPeriodSearch() and supportsVisibleFederation() are true
MethodgetPeriodAdminSession
Description

Gets the OsidSession associated with the period administration service.

Returnosid.billing.PeriodAdminSession a PeriodAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPeriodAdmin() is false
Complianceoptional This method must be implemented if supportsPeriodAdmin() is true.
MethodgetPeriodAdminSessionForBusiness
Description

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

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.PeriodAdminSession a PeriodAdminSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPeriodAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPeriodAdmin() and supportsVisibleFederation() are true
MethodgetPeriodNotificationSession
Description

Gets the OsidSession associated with the period notification service.

Parametersosid.billing.PeriodReceiverperiodReceiver the notification callback
Returnosid.billing.PeriodNotificationSession a PeriodNotificationSession
ErrorsNULL_ARGUMENT periodReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPeriodNotification() is false
Complianceoptional This method must be implemented if supportsPeriodNotification() is true.
MethodgetPeriodNotificationSessionForBusiness
Description

Gets the OsidSession associated with the period notification service for the given business.

Parametersosid.billing.PeriodReceiverperiodReceiver the notification callback
osid.id.IdbusinessId the Id of the Business
Returnosid.billing.PeriodNotificationSession a PeriodNotificationSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT periodReceiver or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPeriodNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPeriodNotification() and supportsVisibleFederation() are true
MethodgetPeriodBusinessSession
Description

Gets the OsidSession to lookup period/catalog mappings.

Returnosid.billing.PeriodBusinessSession a PeriodBusinessSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPeriodBusiness() is false
Complianceoptional This method must be implemented if supportsPeriodBusiness() is true.
MethodgetPeriodBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning periods to businesses.

Returnosid.billing.PeriodBusinessAssignmentSession a PeriodBusinessAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPeriodBusinessAssignment() is false
Complianceoptional This method must be implemented if supportsPeriodBusinessAssignment() is true.
MethodgetPeriodSmartBusinessSession
Description

Gets the OsidSession associated with the period smart business service.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.billing.PeriodSmartBusinessSession a PeriodSmartBusinessSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPeriodSmartBusiness() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPeriodSmartBusiness() and supportsVisibleFederation() are true
MethodgetBusinessLookupSession
Description

Gets the OsidSession associated with the business lookup service.

Returnosid.billing.BusinessLookupSession a BusinessLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBusinessLookup() is false
Complianceoptional This method must be implemented if supportsBusinessLookup() is true.
MethodgetBusinessQuerySession
Description

Gets the OsidSession associated with the business query service.

Returnosid.billing.BusinessQuerySession a BusinessQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBusinessQuery() is false
Complianceoptional This method must be implemented if supportsBusinessQuery() is true.
MethodgetBusinessSearchSession
Description

Gets the OsidSession associated with the business search service.

Returnosid.billing.BusinessSearchSession a BusinessSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBusinessSearch() is false
Complianceoptional This method must be implemented if supportsBusinessSearch() is true.
MethodgetBusinessAdminSession
Description

Gets the OsidSession associated with the business administrative service.

Returnosid.billing.BusinessAdminSession a BusinessAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBusinessAdmin() is false
Complianceoptional This method must be implemented if supportsBusinessAdmin() is true.
MethodgetBusinessNotificationSession
Description

Gets the OsidSession associated with the business notification service.

Parametersosid.billing.BusinessReceiverbusinessReceiver the notification callback
Returnosid.billing.BusinessNotificationSession a BusinessNotificationSession
ErrorsNULL_ARGUMENT businessReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBusinessNotification() is false
Complianceoptional This method must be implemented if supportsBusinessNotification() is true.
MethodgetBusinessHierarchySession
Description

Gets the OsidSession associated with the business hierarchy service.

Returnosid.billing.BusinessHierarchySession a BusinessHierarchySession for businesses
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBusinessHierarchy() is false
Complianceoptional This method must be implemented if supportsBusinessHierarchy() is true.
MethodgetBusinessHierarchyDesignSession
Description

Gets the OsidSession associated with the business hierarchy design service.

Returnosid.billing.BusinessHierarchyDesignSession a HierarchyDesignSession for businesses
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBusinessHierarchyDesign() is false
Complianceoptional This method must be implemented if supportsBusinessHierarchyDesign() is true.
MethodgetBillingBatchManager
Description

Gets a BillingBatchManager.

Returnosid.billing.batch.BillingBatchManager a BillingBatchManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBillingBatch() is false
Complianceoptional This method must be implemented if supportsBillingBatch() is true.
MethodgetBillingPaymentManager
Description

Gets a BillingPaymentManager.

Returnosid.billing.payment.BillingPaymentManager a BillingPaymentManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBillingPayment() is false
Complianceoptional This method must be implemented if supportsBillingPayment() is true.