OSID Logo
OSID Specifications
billing payment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.payment.Payer
Implementsosid.OsidObject
osid.Temporal
Description

A Payer represents the payer of the bills. A Payer links a payment type to a paying contact Resource.

MethodgetResourceId
Description

Gets the resource Id representing the billing contact.

Returnosid.id.Idthe resource Id
CompliancemandatoryThis method must be implemented.
MethodgetResource
Description

Gets the resource.

Returnosid.resource.Resourcethe resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasCustomer
Description

Tests if this payer is linked directly to a customer account.

Returnboolean true if this payer is linked to a customer, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCustomerId
Description

Gets the customer Id.

Returnosid.id.Idthe customer Id
ErrorsILLEGAL_STATE hasCustomer() is false
CompliancemandatoryThis method must be implemented.
MethodgetCustomer
Description

Gets the customer.

Returnosid.billing.Customerthe customer
ErrorsILLEGAL_STATE hasCustomer() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodusesActivity
Description

Tests if this payer uses the customer financial activity for payments. If usesActivity() is true, then usesCash(), hasCreditCard(), and hasBankAccount() must be false.

Returnboolean true if this payer uses the customer activity, false otherwise
ErrorsILLEGAL_STATE hasCustomer() is false
CompliancemandatoryThis method must be implemented.
MethodusesCash
Description

Tests if this payer uses cash for payments.

Returnboolean true if this payer uses the cash, false otherwise
CompliancemandatoryThis method must be implemented.
MethodhasCreditCard
Description

Tests if this payer pays by credit card. If hasCreditCard() is true, then usesActivity(), usesCash(), hasCreditCard(), and hasBankAccount() must be false.

Returnboolean true if this payer pays by credit card, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCreditCardNumber
Description

Gets the credit card number.

Returnstringthe credit card number
ErrorsILLEGAL_STATE hasCreditCard() is false
CompliancemandatoryThis method must be implemented.
MethodgetCreditCardExpiration
Description

Gets the credit card expiration date.

Returnosid.calendaring.DateTimethe expiration date
ErrorsILLEGAL_STATE hasCreditCard() is false
CompliancemandatoryThis method must be implemented.
MethodgetCreditCardCode
Description

Gets the credit card security code.

Returnstringthe credit card security code
ErrorsILLEGAL_STATE hasCreditCard() is false
CompliancemandatoryThis method must be implemented.
MethodhasBankAccount
Description

Tests if this payer pays by bank account If hasBankAccount() is true, then usesActivity(), usesCash(), hasCreditCard(), and hasCreditCard() must be false.

Returnboolean true if this payer pays by bank account, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBankRoutingNumber
Description

Gets the bank routing number.

Returnstringthe bank routing number number
ErrorsILLEGAL_STATE hasBankAccount() is false
CompliancemandatoryThis method must be implemented.
MethodgetBankAccountNumber
Description

Gets the bank account number.

Returnstringthe bank account number
ErrorsILLEGAL_STATE hasBankAccount() is false
CompliancemandatoryThis method must be implemented.
MethodgetPayerRecord
Description

Gets the payer record corresponding to the given Payer record Type. This method is used to retrieve an object implementing the requested record. The payerRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(payerRecordType) is true .

Parametersosid.type.TypepayerRecordTypethe type of payer record to retrieve
Returnosid.billing.payment.records.PayerRecordthe payer record
ErrorsNULL_ARGUMENT payerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(payerRecordType) is false
CompliancemandatoryThis method must be implemented.