public interface BillingPaymentProfile extends OsidProfile
The billing profile describes the interoperability among billing management services.
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.
|
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
boolean supportsVisibleFederation()
true
if visible federation is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsPayerLookup()
true
if payer lookup is supported, false
otherwisemandatory
- This method must be implemented. boolean supportsPayerQuery()
true
if payer query is supported, false
otherwisemandatory
- This method must be implemented. boolean supportsPayerSearch()
true
if payer search is supported, false
otherwisemandatory
- This method must be implemented. boolean supportsPayerAdmin()
administrative service is supported. true
if payer administration is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsPayerNotification()
notification service is supported. true
if payer notification is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsPayerBusiness()
true
if businessing is supported, false
otherwisemandatory
- This method must be implemented. boolean supportsPayerBusinessAssignment()
true
if businessing is supported, false
otherwisemandatory
- This method must be implemented. boolean supportsPayerSmartBusiness()
true
if a payer smart business session is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsPaymentLookup()
true
if payment lookup is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsPaymentQuery()
true
if payment query is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsPaymentSearch()
true
if payment search is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsPaymentAdmin()
administrative service is supported. true
if payment administration is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsPaymentNotification()
notification service is supported. true
if payment notification is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsPaymentBusiness()
true
if payment catalog is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsPaymentBusinessAssignment()
true
if payment cataloging is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsPaymentSmartBusiness()
true
if a payment smart business session is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsSummary()
true
if a summary session is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsBillingPaymentBatch()
true
if a payment batch service is supported,
false
otherwisemandatory
- This method must be implemented. TypeList getPayerRecordTypes()
Payer
record types. Payer
record
typesmandatory
- This method must be implemented. boolean supportsPayerRecordType(Type payerRecordType)
Payer
record type is supported.payerRecordType
- a Type
indicating a
Payer
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- payerRecordType
is null
mandatory
- This method must be implemented. TypeList getPayerSearchRecordTypes()
Payer
search record types. Payer
search
record typesmandatory
- This method must be implemented. boolean supportsPayerSearchRecordType(Type payerSearchRecordType)
Payer
search record type is
supported.payerSearchRecordType
- a Type
indicating a
Payer
search record type true
if the given search record type is
supported, false
otherwiseNullArgumentException
- payerSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getPaymentRecordTypes()
Payment
record types. Payment
record
typesmandatory
- This method must be implemented. boolean supportsPaymentRecordType(Type paymentRecordType)
Payment
record type is supported.paymentRecordType
- a Type
indicating a
Payment
record type true
if the given record type is supported,
false
otherwiseNullArgumentException
- paymentRecordType
is null
mandatory
- This method must be implemented. TypeList getPaymentSearchRecordTypes()
Payment
search record types. Payment
search
record typesmandatory
- This method must be implemented. boolean supportsPaymentSearchRecordType(Type paymentSearchRecordType)
Payment
search record type is
supported.paymentSearchRecordType
- a Type
indicating a
Payment
search record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- paymentSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getSummaryRecordTypes()
Summary
record types. Summary
record
typesmandatory
- This method must be implemented. boolean supportsSummaryRecordType(Type summaryRecordType)
Summary
record type is supported.summaryRecordType
- a Type
indicating a
Summary
record type true
if the given record type is supported,
false
otherwiseNullArgumentException
- summaryRecordType
is null
mandatory
- This method must be implemented.