org.osid.billing.payment

Interface BillingPaymentProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

BillingPaymentManager, BillingPaymentProxyManager

public interface BillingPaymentProfile
extends OsidProfile

The billing profile describes the interoperability among billing management services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getPayerRecordTypes() Gets the supported Payer record types.
TypeList	getPayerSearchRecordTypes() Gets the supported Payer search record types.
TypeList	getPaymentRecordTypes() Gets the supported Payment record types.
TypeList	getPaymentSearchRecordTypes() Gets the supported Payment search record types.
TypeList	getSummaryRecordTypes() Gets the supported Summary record types.
boolean	supportsBillingPaymentBatch() Tests if a payment batch service is available.
boolean	supportsPayerAdmin() Tests if payer administrative service is supported.
boolean	supportsPayerBusiness() Tests if a businessing service is supported.
boolean	supportsPayerBusinessAssignment() Tests if a businessing service is supported.
boolean	supportsPayerLookup() Tests if looking up payers is supported.
boolean	supportsPayerNotification() Tests if a payer notification service is supported.
boolean	supportsPayerQuery() Tests if querying payers is supported.
boolean	supportsPayerRecordType(Type payerRecordType) Tests if the given Payer record type is supported.
boolean	supportsPayerSearch() Tests if searching payers is supported.
boolean	supportsPayerSearchRecordType(Type payerSearchRecordType) Tests if the given Payer search record type is supported.
boolean	supportsPayerSmartBusiness() Tests if a payer smart business session is available.
boolean	supportsPaymentAdmin() Tests if payment administrative service is supported.
boolean	supportsPaymentBusiness() Tests if a payment cataloging service is supported.
boolean	supportsPaymentBusinessAssignment() Tests if a payment cataloging service is supported.
boolean	supportsPaymentLookup() Tests if looking up payments is supported.
boolean	supportsPaymentNotification() Tests if a payment notification service is supported.
boolean	supportsPaymentQuery() Tests if querying payments is supported.
boolean	supportsPaymentRecordType(Type paymentRecordType) Tests if the given Payment record type is supported.
boolean	supportsPaymentSearch() Tests if searching payments is supported.
boolean	supportsPaymentSearchRecordType(Type paymentSearchRecordType) Tests if the given Payment search record type is supported.
boolean	supportsPaymentSmartBusiness() Tests if a payment smart business session is available.
boolean	supportsSummary() Tests if a payment summary session is available.
boolean	supportsSummaryRecordType(Type summaryRecordType) Tests if the given Summary record type is supported.
boolean	supportsVisibleFederation() Tests if any business federation is exposed.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

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.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPayerLookup

boolean supportsPayerLookup()

Tests if looking up payers is supported.

Returns:

true if payer lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPayerQuery

boolean supportsPayerQuery()

Tests if querying payers is supported.

Returns:

true if payer query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPayerSearch

boolean supportsPayerSearch()

Tests if searching payers is supported.

Returns:

true if payer search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPayerAdmin

boolean supportsPayerAdmin()

Tests if payer administrative service is supported.

Returns:

true if payer administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPayerNotification

boolean supportsPayerNotification()

Tests if a payer notification service is supported.

Returns:

true if payer notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPayerBusiness

boolean supportsPayerBusiness()

Tests if a businessing service is supported.

Returns:

true if businessing is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPayerBusinessAssignment

boolean supportsPayerBusinessAssignment()

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

Returns:

true if businessing is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPayerSmartBusiness

boolean supportsPayerSmartBusiness()

Tests if a payer smart business session is available.

Returns:

true if a payer smart business session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPaymentLookup

boolean supportsPaymentLookup()

Tests if looking up payments is supported.

Returns:

true if payment lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPaymentQuery

boolean supportsPaymentQuery()

Tests if querying payments is supported.

Returns:

true if payment query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPaymentSearch

boolean supportsPaymentSearch()

Tests if searching payments is supported.

Returns:

true if payment search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPaymentAdmin

boolean supportsPaymentAdmin()

Tests if payment administrative service is supported.

Returns:

true if payment administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPaymentNotification

boolean supportsPaymentNotification()

Tests if a payment notification service is supported.

Returns:

true if payment notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPaymentBusiness

boolean supportsPaymentBusiness()

Tests if a payment cataloging service is supported.

Returns:

true if payment catalog is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPaymentBusinessAssignment

boolean supportsPaymentBusinessAssignment()

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

Returns:

true if payment cataloging is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPaymentSmartBusiness

boolean supportsPaymentSmartBusiness()

Tests if a payment smart business session is available.

Returns:

true if a payment smart business session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSummary

boolean supportsSummary()

Tests if a payment summary session is available.

Returns:

true if a summary session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBillingPaymentBatch

boolean supportsBillingPaymentBatch()

Tests if a payment batch service is available.

Returns:

true if a payment batch service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getPayerRecordTypes

TypeList getPayerRecordTypes()

Gets the supported Payer record types.

Returns:

a list containing the supported Payer record types

Compliance:

mandatory - This method must be implemented.

supportsPayerRecordType

boolean supportsPayerRecordType(Type payerRecordType)

Tests if the given Payer record type is supported.

Parameters:

payerRecordType - a Type indicating a Payer record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - payerRecordType is null

Compliance:

mandatory - This method must be implemented.

getPayerSearchRecordTypes

TypeList getPayerSearchRecordTypes()

Gets the supported Payer search record types.

Returns:

a list containing the supported Payer search record types

Compliance:

mandatory - This method must be implemented.

supportsPayerSearchRecordType

boolean supportsPayerSearchRecordType(Type payerSearchRecordType)

Tests if the given Payer search record type is supported.

Parameters:

payerSearchRecordType - a Type indicating a Payer search record type

Returns:

true if the given search record type is supported, false otherwise

Throws:

NullArgumentException - payerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getPaymentRecordTypes

TypeList getPaymentRecordTypes()

Gets the supported Payment record types.

Returns:

a list containing the supported Payment record types

Compliance:

mandatory - This method must be implemented.

supportsPaymentRecordType

boolean supportsPaymentRecordType(Type paymentRecordType)

Tests if the given Payment record type is supported.

Parameters:

paymentRecordType - a Type indicating a Payment record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - paymentRecordType is null

Compliance:

mandatory - This method must be implemented.

getPaymentSearchRecordTypes

TypeList getPaymentSearchRecordTypes()

Gets the supported Payment search record types.

Returns:

a list containing the supported Payment search record types

Compliance:

mandatory - This method must be implemented.

supportsPaymentSearchRecordType

boolean supportsPaymentSearchRecordType(Type paymentSearchRecordType)

Tests if the given Payment search record type is supported.

Parameters:

paymentSearchRecordType - a Type indicating a Payment search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - paymentSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getSummaryRecordTypes

TypeList getSummaryRecordTypes()

Gets the supported Summary record types.

Returns:

a list containing the supported Summary record types

Compliance:

mandatory - This method must be implemented.

supportsSummaryRecordType

boolean supportsSummaryRecordType(Type summaryRecordType)

Tests if the given Summary record type is supported.

Parameters:

summaryRecordType - a Type indicating a Summary record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - summaryRecordType is null

Compliance:

mandatory - This method must be implemented.