OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.BillingManager
Implementsosid.OsidManager
osid.billing.BillingProfile
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.CustomerLookupSessiona CustomerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCustomerLookup() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the business
Returnosid.billing.CustomerLookupSessiona CustomerLookupSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCustomerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCustomerLookup() and supportsVisibleFederation() are true
MethodgetCustomerQuerySession
Description

Gets the OsidSession associated with the customer query service.

Returnosid.billing.CustomerQuerySessiona CustomerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCustomerQuery() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.CustomerQuerySessiona CustomerQuerySession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCustomerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCustomerQuery() and supportsVisibleFederation() are true
MethodgetCustomerSearchSession
Description

Gets the OsidSession associated with the customer search service.

Returnosid.billing.CustomerSearchSessiona CustomerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCustomerSearch() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.CustomerSearchSessiona CustomerSearchSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCustomerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCustomerSearch() and supportsVisibleFederation() are true
MethodgetCustomerAdminSession
Description

Gets the OsidSession associated with the customer administration service.

Returnosid.billing.CustomerAdminSessiona CustomerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCustomerAdmin() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.CustomerAdminSessiona CustomerAdminSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCustomerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCustomerAdmin() and supportsVisibleFederation() are true
MethodgetCustomerNotificationSession
Description

Gets the OsidSession associated with the customer notification service.

Parametersosid.billing.CustomerReceivercustomerReceiverthe notification callback
Returnosid.billing.CustomerNotificationSessiona CustomerNotificationSession
ErrorsNULL_ARGUMENT customerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCustomerNotification() is false
ComplianceoptionalThis 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.CustomerReceivercustomerReceiverthe notification callback
osid.id.IdbusinessIdthe Id of the Business
Returnosid.billing.CustomerNotificationSessiona CustomerNotificationSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT customerReceiver or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCustomerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCustomerNotification() and supportsVisibleFederation() are true
MethodgetCustomerBusinessSession
Description

Gets the OsidSession to lookup customer/catalog mappings.

Returnosid.billing.CustomerBusinessSessiona CustomerCustomerBusinessSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCustomerBusiness() is false
ComplianceoptionalThis method must be implemented if supportsCustomerBusiness() is true.
MethodgetCustomerBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning customers to businesses.

Returnosid.billing.CustomerBusinessAssignmentSessiona CustomerBusinessAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCustomerBusinessAssignment() is false
ComplianceoptionalThis method must be implemented if supportsCustomerBusinessAssignment() is true.
MethodgetCustomerSmartBusinessSession
Description

Gets the OsidSession associated with the customer smart business service.

Parametersosid.id.IdbusinessIdthe Id of the Business
Returnosid.billing.CustomerSmartBusinessSessiona CustomerSmartBusinessSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCustomerSmartBusiness() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCustomerSmartBusiness() and supportsVisibleFederation() are true
MethodgetItemLookupSession
Description

Gets the OsidSession associated with the item lookup service.

Returnosid.billing.ItemLookupSessionan ItemSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemLookup() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the business
Returnosid.billing.ItemLookupSessionan ItemLookupSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsItemLookup() and supportsVisibleFederation() are true
MethodgetItemQuerySession
Description

Gets the OsidSession associated with the item query service.

Returnosid.billing.CustomerQuerySessionan ItemQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemQuery() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.CustomerQuerySessionan ItemQuerySession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsItemQuery() and supportsVisibleFederation() are true
MethodgetItemSearchSession
Description

Gets the OsidSession associated with the item search service.

Returnosid.billing.ItemSearchSessionan ItemSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemSearch() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.ItemSearchSessionan ItemSearchSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsItemSearch() and supportsVisibleFederation() are true
MethodgetItemAdminSession
Description

Gets the OsidSession associated with the item administration service.

Returnosid.billing.ItemAdminSessionan ItemAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemAdmin() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.ItemAdminSessionan ItemAdminSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsItemAdmin() and supportsVisibleFederation() are true
MethodgetItemNotificationSession
Description

Gets the OsidSession associated with the item notification service.

Parametersosid.billing.ItemReceiveritemReceiverthe notification callback
Returnosid.billing.ItemNotificationSessionan ItemNotificationSession
ErrorsNULL_ARGUMENT itemReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemNotification() is false
ComplianceoptionalThis 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.ItemReceiveritemReceiverthe notification callback
osid.id.IdbusinessIdthe Id of the Business
Returnosid.billing.ItemNotificationSessionan ItemNotificationSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT itemReceiver or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsItemNotification() and supportsVisibleFederation() are true
MethodgetItemBusinessSession
Description

Gets the OsidSession to lookup item/catalog mappings.

Returnosid.billing.ItemBusinessSessionan ItemBusinessSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemBusiness() is false
ComplianceoptionalThis method must be implemented if supportsItemBusiness() is true.
MethodgetItemBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning items to businesses.

Returnosid.billing.ItemBusinessAssignmentSessionan ItemBusinessAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemBusinessAssignment() is false
ComplianceoptionalThis method must be implemented if supportsItemBusinessAssignment() is true.
MethodgetItemSmartBusinessSession
Description

Gets the OsidSession associated with the item smart business service.

Parametersosid.id.IdbusinessIdthe Id of the Business
Returnosid.billing.ItemSmartBusinessSessionan ItemSmartBusinessSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemSmartBusiness() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsItemSmartBusiness() and supportsVisibleFederation() are true
MethodgetCategoryLookupSession
Description

Gets the OsidSession associated with the category lookup service.

Returnosid.billing.CategoryLookupSessiona CategorySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCategoryLookup() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the business
Returnosid.billing.CategoryLookupSessiona CategoryLookupSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCategoryLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCategoryLookup() and supportsVisibleFederation() are true
MethodgetCategoryQuerySession
Description

Gets the OsidSession associated with the category query service.

Returnosid.billing.CustomerQuerySessiona CategoryQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCategoryQuery() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.CustomerQuerySessiona CategoryQuerySession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCategoryQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCategoryQuery() and supportsVisibleFederation() are true
MethodgetCategorySearchSession
Description

Gets the OsidSession associated with the category search service.

Returnosid.billing.CategorySearchSessiona CategorySearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCategorySearch() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.CategorySearchSessiona CategorySearchSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCategorySearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCategorySearch() and supportsVisibleFederation() are true
MethodgetCategoryAdminSession
Description

Gets the OsidSession associated with the category administration service.

Returnosid.billing.CategoryAdminSessiona CategoryAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCategoryAdmin() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.CategoryAdminSessiona CategoryAdminSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCategoryAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCategoryAdmin() and supportsVisibleFederation() are true
MethodgetCategoryNotificationSession
Description

Gets the OsidSession associated with the category notification service.

Parametersosid.billing.CategoryReceivercategoryReceiverthe notification callback
Returnosid.billing.CategoryNotificationSessiona CategoryNotificationSession
ErrorsNULL_ARGUMENT categoryReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCategoryNotification() is false
ComplianceoptionalThis 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.CategoryReceivercategoryReceiverthe notification callback
osid.id.IdbusinessIdthe Id of the Business
Returnosid.billing.CategoryNotificationSessiona CategoryNotificationSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT categoryReceiver or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCategoryNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCategoryNotification() and supportsVisibleFederation() are true
MethodgetCategoryBusinessSession
Description

Gets the OsidSession to lookup category/catalog mappings.

Returnosid.billing.CategoryBusinessSessiona CategoryBusinessSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCategoryBusiness() is false
ComplianceoptionalThis method must be implemented if supportsCategoryBusiness() is true.
MethodgetCategoryBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning categories to businesses.

Returnosid.billing.CategoryBusinessAssignmentSessiona CategoryBusinessAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCategoryBusinessAssignment() is false
ComplianceoptionalThis method must be implemented if supportsCategoryBusinessAssignment() is true.
MethodgetCategorySmartBusinessSession
Description

Gets the OsidSession associated with the category smart business service.

Parametersosid.id.IdbusinessIdthe Id of the Business
Returnosid.billing.CategorySmartBusinessSessiona CategorySmartBusinessSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCategorySmartBusiness() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCategorySmartBusiness() and supportsVisibleFederation() are true
MethodgetEntryLookupSession
Description

Gets the OsidSession associated with the entry lookup service.

Returnosid.billing.EntryLookupSessionan EntryLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryLookup() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.EntryLookupSessionan EntryLookupSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEntryLookup() and supportsVisibleFederation() are true
MethodgetEntryQuerySession
Description

Gets the OsidSession associated with the entry query service.

Returnosid.billing.EntryQuerySessionan EntryQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryQuery() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.EntryQuerySessionan EntryQuerySession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEntryQuery() and supportsVisibleFederation() are true
MethodgetEntrySearchSession
Description

Gets the OsidSession associated with the entry search service.

Returnosid.billing.EntrySearchSessionan EntrySearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntrySearch() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.EntrySearchSessionan EntrySearchSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntrySearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEntrySearch() and supportsVisibleFederation() are true
MethodgetEntryAdminSession
Description

Gets the OsidSession associated with the entry administration service.

Returnosid.billing.EntryAdminSessionan EntryAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryAdmin() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.EntryAdminSessionan EntryAdminSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEntryAdmin() and supportsVisibleFederation() are true
MethodgetEntryNotificationSession
Description

Gets the OsidSession associated with the entry notification service.

Parametersosid.billing.EntryReceiverentryReceiverthe notification callback
Returnosid.billing.EntryNotificationSessionan EntryNotificationSession
ErrorsNULL_ARGUMENT entryReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryNotification() is false
ComplianceoptionalThis 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.EntryReceiverentryReceiverthe notification callback
osid.id.IdbusinessIdthe Id of the Business
Returnosid.billing.EntryNotificationSessionan EntryNotificationSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT entryReceiver or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEntryNotification() and supportsVisibleFederation() are true
MethodgetEntryBusinessSession
Description

Gets the OsidSession to lookup entry/catalog mappings.

Returnosid.billing.EntryBusinessSessionan EntryBusinessSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryBusiness() is false
ComplianceoptionalThis method must be implemented if supportsEntryBusiness() is true.
MethodgetEntryBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning entries to businesses.

Returnosid.billing.EntryBusinessAssignmentSessionan EntryBusinessAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryBusinessAssignment() is false
ComplianceoptionalThis method must be implemented if supportsEntryBusinessAssignment() is true.
MethodgetEntrySmartBusinessSession
Description

Gets the OsidSession associated with the entry smart business service.

Parametersosid.id.IdbusinessIdthe Id of the Business
Returnosid.billing.EntrySmartBusinessSessionan EntrySmartBusinessSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntrySmartBusiness() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEntrySmartBusiness() and supportsVisibleFederation() are true
MethodgetPeriodLookupSession
Description

Gets the OsidSession associated with the period lookup service.

Returnosid.billing.PeriodLookupSessiona PeriodLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPeriodLookup() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.PeriodLookupSessiona PeriodLookupSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPeriodLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPeriodLookup() and supportsVisibleFederation() are true
MethodgetPeriodQuerySession
Description

Gets the OsidSession associated with the period query service.

Returnosid.billing.PeriodQuerySessiona PeriodQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPeriodQuery() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.PeriodQuerySessiona PeriodQuerySession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPeriodQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPeriodQuery() and supportsVisibleFederation() are true
MethodgetPeriodSearchSession
Description

Gets the OsidSession associated with the period search service.

Returnosid.billing.PeriodSearchSessiona PeriodSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPeriodSearch() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.PeriodSearchSessiona PeriodSearchSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPeriodSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPeriodSearch() and supportsVisibleFederation() are true
MethodgetPeriodAdminSession
Description

Gets the OsidSession associated with the period administration service.

Returnosid.billing.PeriodAdminSessiona PeriodAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPeriodAdmin() is false
ComplianceoptionalThis 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.IdbusinessIdthe Id of the Business
Returnosid.billing.PeriodAdminSessiona PeriodAdminSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPeriodAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPeriodAdmin() and supportsVisibleFederation() are true
MethodgetPeriodNotificationSession
Description

Gets the OsidSession associated with the period notification service.

Parametersosid.billing.PeriodReceiverperiodReceiverthe notification callback
Returnosid.billing.PeriodNotificationSessiona PeriodNotificationSession
ErrorsNULL_ARGUMENT periodReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPeriodNotification() is false
ComplianceoptionalThis 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.PeriodReceiverperiodReceiverthe notification callback
osid.id.IdbusinessIdthe Id of the Business
Returnosid.billing.PeriodNotificationSessiona PeriodNotificationSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT periodReceiver or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPeriodNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPeriodNotification() and supportsVisibleFederation() are true
MethodgetPeriodBusinessSession
Description

Gets the OsidSession to lookup period/catalog mappings.

Returnosid.billing.PeriodBusinessSessiona PeriodBusinessSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPeriodBusiness() is false
ComplianceoptionalThis method must be implemented if supportsPeriodBusiness() is true.
MethodgetPeriodBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning periods to businesses.

Returnosid.billing.PeriodBusinessAssignmentSessiona PeriodBusinessAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPeriodBusinessAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPeriodBusinessAssignment() is true.
MethodgetPeriodSmartBusinessSession
Description

Gets the OsidSession associated with the period smart business service.

Parametersosid.id.IdbusinessIdthe Id of the Business
Returnosid.billing.PeriodSmartBusinessSessiona PeriodSmartBusinessSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPeriodSmartBusiness() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPeriodSmartBusiness() and supportsVisibleFederation() are true
MethodgetBusinessLookupSession
Description

Gets the OsidSession associated with the business lookup service.

Returnosid.billing.BusinessLookupSessiona BusinessLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBusinessLookup() is false
ComplianceoptionalThis method must be implemented if supportsBusinessLookup() is true.
MethodgetBusinessQuerySession
Description

Gets the OsidSession associated with the business query service.

Returnosid.billing.BusinessQuerySessiona BusinessQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBusinessQuery() is false
ComplianceoptionalThis method must be implemented if supportsBusinessQuery() is true.
MethodgetBusinessSearchSession
Description

Gets the OsidSession associated with the business search service.

Returnosid.billing.BusinessSearchSessiona BusinessSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBusinessSearch() is false
ComplianceoptionalThis method must be implemented if supportsBusinessSearch() is true.
MethodgetBusinessAdminSession
Description

Gets the OsidSession associated with the business administrative service.

Returnosid.billing.BusinessAdminSessiona BusinessAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBusinessAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBusinessAdmin() is true.
MethodgetBusinessNotificationSession
Description

Gets the OsidSession associated with the business notification service.

Parametersosid.billing.BusinessReceiverbusinessReceiverthe notification callback
Returnosid.billing.BusinessNotificationSessiona BusinessNotificationSession
ErrorsNULL_ARGUMENT businessReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBusinessNotification() is false
ComplianceoptionalThis method must be implemented if supportsBusinessNotification() is true.
MethodgetBusinessHierarchySession
Description

Gets the OsidSession associated with the business hierarchy service.

Returnosid.billing.BusinessHierarchySessiona BusinessHierarchySession for businesses
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBusinessHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsBusinessHierarchy() is true.
MethodgetBusinessHierarchyDesignSession
Description

Gets the OsidSession associated with the business hierarchy design service.

Returnosid.billing.BusinessHierarchyDesignSessiona HierarchyDesignSession for businesses
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBusinessHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsBusinessHierarchyDesign() is true.
MethodgetBillingBatchManager
Description

Gets a BillingBatchManager.

Returnosid.billing.batch.BillingBatchManagera BillingBatchManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBillingBatch() is false
ComplianceoptionalThis method must be implemented if supportsBillingBatch() is true.
MethodgetBillingPaymentManager
Description

Gets a BillingPaymentManager.

Returnosid.billing.payment.BillingPaymentManagera BillingPaymentManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBillingPayment() is false
ComplianceoptionalThis method must be implemented if supportsBillingPayment() is true.