| Interface | osid.billing.BillingProxyManager | ||
|---|---|---|---|
| Implements | osid.OsidProxyManager | ||
osid.billing.BillingProfile | |||
| Description |
The customer manager provides access to customer management
sessions and provides interoperability tests for various
aspects of this service. Methods in this manager support the
passing of a
| ||
| Method | getCustomerLookupSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.CustomerLookupSession | a CustomerLookupSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCustomerLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsCustomerLookup()
is true. | |
| Method | getCustomerLookupSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.CustomerLookupSession | a CustomerLookupSession | |
| Errors | NOT_FOUND | no Business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCustomerLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsCustomerLookup()
and supportsVisibleFederation() are true | |
| Method | getCustomerQuerySession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.CustomerQuerySession | a CustomerQuerySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCustomerQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsCustomerQuery()
is true. | |
| Method | getCustomerQuerySessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.CustomerQuerySession | a CustomerQuerySession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCustomerQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsCustomerQuery()
and supportsVisibleFederation() are true | |
| Method | getCustomerSearchSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.CustomerSearchSession | a CustomerSearchSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCustomerSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsCustomerSearch()
is true. | |
| Method | getCustomerSearchSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.CustomerSearchSession | a CustomerSearchSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCustomerSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsCustomerSearch()
and supportsVisibleFederation() are true | |
| Method | getCustomerAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.CustomerAdminSession | a CustomerAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCustomerAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsCustomerAdmin()
is true. | |
| Method | getCustomerAdminSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.CustomerAdminSession | a CustomerAdminSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCustomerAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsCustomerAdmin()
and supportsVisibleFederation() are true | |
| Method | getCustomerNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.billing.CustomerReceiver | customerReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.CustomerNotificationSession | a CustomerNotificationSession | |
| Errors | NULL_ARGUMENT | customerReceiver or proxy is null
| |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCustomerNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsCustomerNotification()
is true. | |
| Method | getCustomerNotificationSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.billing.CustomerReceiver | customerReceiver | the notification callback |
osid.id.Id | businessId | the Id of the Business | |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.CustomerNotificationSession | a CustomerNotificationSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | customerReceiver, businessId or proxy is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCustomerNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsCustomerNotification()
and supportsVisibleFederation() are true | |
| Method | getCustomerBusinessSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.CustomerBusinessSession | a CustomerBusinessSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCustomerBusiness() is false | ||
| Compliance | optional | This method must be implemented if supportsCustomerBusiness()
is true. | |
| Method | getCustomerBusinessAssignmentSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.CustomerBusinessAssignmentSession | a CustomerBusinessAssignmentSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCustomerBusinessAssignment() is false | ||
| Compliance | optional | This method must be implemented if
supportsCustomerBusinessAssignment() is true. | |
| Method | getCustomerSmartBusinessSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.CustomerSmartBusinessSession | a CustomerSmartBusinessSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | businessId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCustomerSmartBusiness() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsCustomerSmartBusiness()
and supportsVisibleFederation() are true | |
| Method | getItemLookupSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.ItemLookupSession | an ItemSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsItemLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsItemLookup() is
true. | |
| Method | getItemLookupSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.ItemLookupSession | an ItemLookupSession | |
| Errors | NOT_FOUND | no Business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsItemLookup() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsItemLookup() and
supportsVisibleFederation() are true | |
| Method | getItemQuerySession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.ItemQuerySession | an ItemQuerySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsItemQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsItemQuery() is
true. | |
| Method | getItemQuerySessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.ItemQuerySession | an ItemQuerySession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsItemQuery() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsItemQuery() and
supportsVisibleFederation() are true | |
| Method | getItemSearchSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.ItemSearchSession | an ItemSearchSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsItemSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsItemSearch() is
true. | |
| Method | getItemSearchSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.ItemSearchSession | an ItemSearchSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsItemSearch() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsItemSearch() and
supportsVisibleFederation() are true | |
| Method | getItemAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.ItemAdminSession | an ItemAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsItemAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsItemAdmin() is
true. | |
| Method | getItemAdminSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.ItemAdminSession | an ItemAdminSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsItemAdmin() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsItemAdmin() and
supportsVisibleFederation() are true | |
| Method | getItemNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.billing.ItemReceiver | itemReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.ItemNotificationSession | an ItemNotificationSession | |
| Errors | NULL_ARGUMENT | itemReceiver or proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsItemNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsItemNotification()
is true. | |
| Method | getItemNotificationSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.billing.ItemReceiver | itemReceiver | the notification callback |
osid.id.Id | businessId | the Id of the Business | |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.ItemNotificationSession | an ItemNotificationSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | itemReceiver, businessId or proxy is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsItemNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsItemNotification()
and supportsVisibleFederation() are true | |
| Method | getItemBusinessSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.ItemBusinessSession | an ItemCatalogSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsItemCatalog() is false | ||
| Compliance | optional | This method must be implemented if supportsItemCatalog() is
true. | |
| Method | getItemBusinessAssignmentSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.ItemBusinessAssignmentSession | an ItemCatalogAssignmentSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsItemCatalogAssignment() is false | ||
| Compliance | optional | This method must be implemented if supportsItemCatalogAssignment()
is true. | |
| Method | getItemSmartBusinessSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.ItemSmartBusinessSession | an ItemSmartBusinessSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | businessId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsItemSmartBusiness() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsItemSmartBusiness()
and supportsVisibleFederation() are true | |
| Method | getCategoryLookupSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.CategoryLookupSession | a CategorySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCategoryLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsCategoryLookup()
is true. | |
| Method | getCategoryLookupSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.CategoryLookupSession | a CategoryLookupSession | |
| Errors | NOT_FOUND | no Business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCategoryLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsCategoryLookup()
and supportsVisibleFederation() are true | |
| Method | getCategoryQuerySession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.CategoryQuerySession | a CategoryQuerySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCategoryQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsCategoryQuery()
is true. | |
| Method | getCategoryQuerySessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.CategoryQuerySession | a CategoryQuerySession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCategoryQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsCategoryQuery()
and supportsVisibleFederation() are true | |
| Method | getCategorySearchSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.CategorySearchSession | a CategorySearchSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCategorySearch() is false | ||
| Compliance | optional | This method must be implemented if supportsCategorySearch()
is true. | |
| Method | getCategorySearchSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.CategorySearchSession | a CategorySearchSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCategorySearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsCategorySearch()
and supportsVisibleFederation() are true | |
| Method | getCategoryAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.CategoryAdminSession | a CategoryAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCategoryAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsCategoryAdmin()
is true. | |
| Method | getCategoryAdminSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.CategoryAdminSession | a CategoryAdminSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCategoryAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsCategoryAdmin()
and supportsVisibleFederation() are true | |
| Method | getCategoryNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.billing.CategoryReceiver | categoryReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.CategoryNotificationSession | a CategoryNotificationSession | |
| Errors | NULL_ARGUMENT | categoryReceiver or proxy is null
| |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCategoryNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsCategoryNotification()
is true. | |
| Method | getCategoryNotificationSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.billing.CategoryReceiver | categoryReceiver | the notification callback |
osid.id.Id | businessId | the Id of the Business | |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.CategoryNotificationSession | a CategoryNotificationSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | categoryReceiver, businessId or proxy is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCategoryNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsCategoryNotification()
and supportsVisibleFederation() are true | |
| Method | getCategoryBusinessSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.CategoryBusinessSession | a CategoryBusinessSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCategoryBusiness() is false | ||
| Compliance | optional | This method must be implemented if supportsCategoryBusiness()
is true. | |
| Method | getCategoryBusinessAssignmentSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.CategoryBusinessAssignmentSession | a CategoryBusinessAssignmentSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCategoryBusinessAssignment() is false | ||
| Compliance | optional | This method must be implemented if
supportsCategoryBusinessAssignment() is true. | |
| Method | getCategorySmartBusinessSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.CategorySmartBusinessSession | a CategorySmartBusinessSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | businessId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCategorySmartBusiness() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsCategorySmartBusiness()
and supportsVisibleFederation() are true | |
| Method | getEntryLookupSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.EntryLookupSession | an EntryLookupSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEntryLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsEntryLookup() is
true. | |
| Method | getEntryLookupSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.EntryLookupSession | an EntryLookupSession | |
| Errors | NOT_FOUND | no Business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEntryLookup() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsEntryLookup() and
supportsVisibleFederation() are true | |
| Method | getEntryQuerySession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.EntryQuerySession | an EntryQuerySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEntryQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsEntryQuery() is
true. | |
| Method | getEntryQuerySessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.EntryQuerySession | an EntryQuerySession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | businessId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEntryQuery() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsEntryQuery() and
supportsVisibleFederation() are true | |
| Method | getEntrySearchSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.EntrySearchSession | an EntrySearchSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEntrySearch() is false | ||
| Compliance | optional | This method must be implemented if supportsEntrySearch() is
true. | |
| Method | getEntrySearchSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.EntrySearchSession | an EntrySearchSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEntrySearch() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsEntrySearch() and
supportsVisibleFederation() are true | |
| Method | getEntryAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.EntryAdminSession | an EntryAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEntryAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsEntryAdmin() is
true. | |
| Method | getEntryAdminSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.EntryAdminSession | an EntryAdminSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEntryAdmin() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsEntryAdmin() and
supportsVisibleFederation() are true | |
| Method | getEntryNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.billing.EntryReceiver | entryReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.EntryNotificationSession | an EntryNotificationSession | |
| Errors | NULL_ARGUMENT | entryReceiver or proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEntryNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsEntryNotification()
is true. | |
| Method | getEntryNotificationSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.billing.EntryReceiver | entryReceiver | the notification callback |
osid.id.Id | businessId | the Id of the Business | |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.EntryNotificationSession | an EntryNotificationSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | entryReceiver, businessId, or proxy is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEntryNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsEntryNotification()
and supportsVisibleFederation() are true | |
| Method | getEntryBusinessSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.EntryBusinessSession | an EntryCatalogSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEntryCatalog() is false | ||
| Compliance | optional | This method must be implemented if supportsEntryCatalog() is
true. | |
| Method | getEntryBusinessAssignmentSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.EntryBusinessAssignmentSession | an EntryCatalogAssignmentSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEntryCatalogAssignment() is false | ||
| Compliance | optional | This method must be implemented if supportsEntryCatalogAssignment()
is true. | |
| Method | getEntrySmartBusinessSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.EntrySmartBusinessSession | an EntrySmartBusinessSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | businessId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEntrySmartBusiness() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsEntrySmartBusiness()
and supportsVisibleFederation() are true | |
| Method | getPeriodLookupSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.PeriodLookupSession | a PeriodLookupSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPeriodLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsPeriodLookup() is
true. | |
| Method | getPeriodLookupSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.PeriodLookupSession | a PeriodLookupSession | |
| Errors | NOT_FOUND | no Business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPeriodLookup() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsPeriodLookup()
and supportsVisibleFederation() are true | |
| Method | getPeriodQuerySession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.PeriodQuerySession | a PeriodQuerySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPeriodQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsPeriodQuery() is
true. | |
| Method | getPeriodQuerySessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.PeriodQuerySession | a PeriodQuerySession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | businessId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPeriodQuery() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsPeriodQuery() and
supportsVisibleFederation() are true | |
| Method | getPeriodSearchSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.PeriodSearchSession | a PeriodSearchSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPeriodSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsPeriodSearch() is
true. | |
| Method | getPeriodSearchSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.PeriodSearchSession | a PeriodSearchSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPeriodSearch() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsPeriodSearch()
and supportsVisibleFederation() are true | |
| Method | getPeriodAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.PeriodAdminSession | a PeriodAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPeriodAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsPeriodAdmin() is
true. | |
| Method | getPeriodAdminSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.PeriodAdminSession | a PeriodAdminSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | proxy or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPeriodAdmin() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsPeriodAdmin() and
supportsVisibleFederation() are true | |
| Method | getPeriodNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.billing.PeriodReceiver | periodReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.PeriodNotificationSession | a PeriodNotificationSession | |
| Errors | NULL_ARGUMENT | periodReceiver or proxy is null
| |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPeriodNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsPeriodNotification()
is true. | |
| Method | getPeriodNotificationSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.billing.PeriodReceiver | periodReceiver | the notification callback |
osid.id.Id | businessId | the Id of the Business | |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.PeriodNotificationSession | a PeriodNotificationSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | periodReceiver, businessId or proxy is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPeriodNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsPeriodNotification()
and supportsVisibleFederation() are true | |
| Method | getPeriodBusinessSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.PeriodBusinessSession | a PeriodCatalogSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPeriodCatalog() is false | ||
| Compliance | optional | This method must be implemented if supportsPeriodCatalog()
is true. | |
| Method | getPeriodBusinessAssignmentSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.PeriodBusinessAssignmentSession | a PeriodCatalogAssignmentSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPeriodCatalogAssignment() is false | ||
| Compliance | optional | This method must be implemented if supportsPeriodCatalogAssignment()
is true. | |
| Method | getPeriodSmartBusinessSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.PeriodSmartBusinessSession | a PeriodSmartBusinessSession | |
| Errors | NOT_FOUND | no business found by the given Id | |
| NULL_ARGUMENT | businessId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPeriodSmartBusiness() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsPeriodSmartBusiness()
and supportsVisibleFederation() are true | |
| Method | getBusinessLookupSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.BusinessLookupSession | a BusinessLookupSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsBusinessLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsBusinessLookup()
is true. | |
| Method | getBusinessQuerySession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.BusinessQuerySession | a BusinessQuerySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsBusinessQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsBusinessQuery()
is true. | |
| Method | getBusinessSearchSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.BusinessSearchSession | a BusinessSearchSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsBusinessSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsBusinessSearch()
is true. | |
| Method | getBusinessAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.BusinessAdminSession | a BusinessAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsBusinessAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsBusinessAdmin()
is true. | |
| Method | getBusinessNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.billing.BusinessReceiver | businessReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
| Return | osid.billing.BusinessNotificationSession | a BusinessNotificationSession | |
| Errors | NULL_ARGUMENT | businessReceiver or proxy is null
| |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsBusinessNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsBusinessNotification()
is true. | |
| Method | getBusinessHierarchySession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.BusinessHierarchySession | a BusinessHierarchySession for businesses | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsBusinessHierarchy() is false | ||
| Compliance | optional | This method must be implemented if supportsBusinessHierarchy()
is true. | |
| Method | getBusinessHierarchyDesignSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | proxy |
| Return | osid.billing.BusinessHierarchyDesignSession | a HierarchyDesignSession for businesses | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsBusinessHierarchyDesign() is false | ||
| Compliance | optional | This method must be implemented if supportsBusinessHierarchyDesign()
is true. | |
| Method | getBillingBatchProxyManager | ||
| Description |
Gets a | ||
| Return | osid.billing.batch.BillingBatchProxyManager | a BillingBatchProxyManager | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsBillingBatch() is false | ||
| Compliance | optional | This method must be implemented if supportsBillingBatch() is
true. | |
| Method | getBillingPaymentProxyManager | ||
| Description |
Gets a | ||
| Return | osid.billing.payment.BillingPaymentProxyManager | a BillingPaymentProxyManager | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsBillingPayment() is false | ||
| Compliance | optional | This method must be implemented if supportsBillingPayment()
is true. | |