OSID - osid.billing.payment.BillingPaymentProfile Service Interface Definition

Interface	osid.billing.payment.BillingPaymentProfile
Implements	`osid.OsidProfile`
Description	The billing profile describes the interoperability among billing management services.
Method	supportsVisibleFederation
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.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPayerLookup
Description	Tests if looking up payers is supported.
Return	`boolean`		`true` if payer lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPayerQuery
Description	Tests if querying payers is supported.
Return	`boolean`		`true` if payer query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPayerSearch
Description	Tests if searching payers is supported.
Return	`boolean`		`true` if payer search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPayerAdmin
Description	Tests if payer administrative service is supported.
Return	`boolean`		`true` if payer administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPayerNotification
Description	Tests if a payer notification service is supported.
Return	`boolean`		`true` if payer notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPayerBusiness
Description	Tests if a businessing service is supported.
Return	`boolean`		`true` if businessing is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPayerBusinessAssignment
Description	Tests if a businessing service is supported. A businessing service maps payers to catalogs.
Return	`boolean`		`true` if businessing is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPayerSmartBusiness
Description	Tests if a payer smart business session is available.
Return	`boolean`		`true` if a payer smart business session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPaymentLookup
Description	Tests if looking up payments is supported.
Return	`boolean`		`true` if payment lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPaymentQuery
Description	Tests if querying payments is supported.
Return	`boolean`		`true` if payment query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPaymentSearch
Description	Tests if searching payments is supported.
Return	`boolean`		`true` if payment search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPaymentAdmin
Description	Tests if payment administrative service is supported.
Return	`boolean`		`true` if payment administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPaymentNotification
Description	Tests if a payment notification service is supported.
Return	`boolean`		`true` if payment notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPaymentBusiness
Description	Tests if a payment cataloging service is supported.
Return	`boolean`		`true` if payment catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPaymentBusinessAssignment
Description	Tests if a payment cataloging service is supported. A cataloging service maps payments to catalogs.
Return	`boolean`		`true` if payment cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPaymentSmartBusiness
Description	Tests if a payment smart business session is available.
Return	`boolean`		`true` if a payment smart business session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSummary
Description	Tests if a payment summary session is available.
Return	`boolean`		`true` if a summary session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBillingPaymentBatch
Description	Tests if a payment batch service is available.
Return	`boolean`		`true` if a payment batch service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPayerRecordTypes
Description	Gets the supported `Payer` record types.
Return	`osid.type.TypeList`		a list containing the supported `Payer` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPayerRecordType
Description	Tests if the given `Payer` record type is supported.
Parameters	`osid.type.Type`	`payerRecordType`	a `Type` indicating a `Payer` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`payerRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPayerSearchRecordTypes
Description	Gets the supported `Payer` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Payer` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPayerSearchRecordType
Description	Tests if the given `Payer` search record type is supported.
Parameters	`osid.type.Type`	`payerSearchRecordType`	a `Type` indicating a `Payer` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`payerSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentRecordTypes
Description	Gets the supported `Payment` record types.
Return	`osid.type.TypeList`		a list containing the supported `Payment` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPaymentRecordType
Description	Tests if the given `Payment` record type is supported.
Parameters	`osid.type.Type`	`paymentRecordType`	a `Type` indicating a `Payment` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`paymentRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentSearchRecordTypes
Description	Gets the supported `Payment` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Payment` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPaymentSearchRecordType
Description	Tests if the given `Payment` search record type is supported.
Parameters	`osid.type.Type`	`paymentSearchRecordType`	a `Type` indicating a `Payment` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`paymentSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSummaryRecordTypes
Description	Gets the supported `Summary` record types.
Return	`osid.type.TypeList`		a list containing the supported `Summary` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsSummaryRecordType
Description	Tests if the given `Summary` record type is supported.
Parameters	`osid.type.Type`	`summaryRecordType`	a `Type` indicating a `Summary` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`summaryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.