OSID Logo
OSID Specifications
billing payment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.payment.BillingPaymentProfile
Implementsosid.OsidProfile
Description

The billing profile describes the interoperability among billing management services.

MethodsupportsVisibleFederation
Description

Tests if any business federation is exposed. Federation is exposed when a specific business may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of catalogs appears as a single catalog.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPayerLookup
Description

Tests if looking up payers is supported.

Returnboolean true if payer lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPayerQuery
Description

Tests if querying payers is supported.

Returnboolean true if payer query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPayerSearch
Description

Tests if searching payers is supported.

Returnboolean true if payer search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPayerAdmin
Description

Tests if payer administrative service is supported.

Returnboolean true if payer administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPayerNotification
Description

Tests if a payer notification service is supported.

Returnboolean true if payer notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPayerBusiness
Description

Tests if a businessing service is supported.

Returnboolean true if businessing is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPayerBusinessAssignment
Description

Tests if a businessing service is supported. A businessing service maps payers to catalogs.

Returnboolean true if businessing is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPayerSmartBusiness
Description

Tests if a payer smart business session is available.

Returnboolean true if a payer smart business session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPaymentLookup
Description

Tests if looking up payments is supported.

Returnboolean true if payment lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPaymentQuery
Description

Tests if querying payments is supported.

Returnboolean true if payment query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPaymentSearch
Description

Tests if searching payments is supported.

Returnboolean true if payment search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPaymentAdmin
Description

Tests if payment administrative service is supported.

Returnboolean true if payment administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPaymentNotification
Description

Tests if a payment notification service is supported.

Returnboolean true if payment notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPaymentBusiness
Description

Tests if a payment cataloging service is supported.

Returnboolean true if payment catalog is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPaymentBusinessAssignment
Description

Tests if a payment cataloging service is supported. A cataloging service maps payments to catalogs.

Returnboolean true if payment cataloging is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPaymentSmartBusiness
Description

Tests if a payment smart business session is available.

Returnboolean true if a payment smart business session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSummary
Description

Tests if a payment summary session is available.

Returnboolean true if a summary session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBillingPaymentBatch
Description

Tests if a payment batch service is available.

Returnboolean true if a payment batch service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPayerRecordTypes
Description

Gets the supported Payer record types.

Returnosid.type.TypeLista list containing the supported Payer record types
CompliancemandatoryThis method must be implemented.
MethodsupportsPayerRecordType
Description

Tests if the given Payer record type is supported.

Parametersosid.type.TypepayerRecordTypea Type indicating a Payer record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT payerRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetPayerSearchRecordTypes
Description

Gets the supported Payer search record types.

Returnosid.type.TypeLista list containing the supported Payer search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsPayerSearchRecordType
Description

Tests if the given Payer search record type is supported.

Parametersosid.type.TypepayerSearchRecordTypea Type indicating a Payer search record type
Returnboolean true if the given search record type is supported, false otherwise
ErrorsNULL_ARGUMENT payerSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetPaymentRecordTypes
Description

Gets the supported Payment record types.

Returnosid.type.TypeLista list containing the supported Payment record types
CompliancemandatoryThis method must be implemented.
MethodsupportsPaymentRecordType
Description

Tests if the given Payment record type is supported.

Parametersosid.type.TypepaymentRecordTypea Type indicating a Payment record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT paymentRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetPaymentSearchRecordTypes
Description

Gets the supported Payment search record types.

Returnosid.type.TypeLista list containing the supported Payment search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsPaymentSearchRecordType
Description

Tests if the given Payment search record type is supported.

Parametersosid.type.TypepaymentSearchRecordTypea Type indicating a Payment search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT paymentSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetSummaryRecordTypes
Description

Gets the supported Summary record types.

Returnosid.type.TypeLista list containing the supported Summary record types
CompliancemandatoryThis method must be implemented.
MethodsupportsSummaryRecordType
Description

Tests if the given Summary record type is supported.

Parametersosid.type.TypesummaryRecordTypea Type indicating a Summary record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT summaryRecordType is null
CompliancemandatoryThis method must be implemented.