Interface | osid.billing.payment.Payer | ||
---|---|---|---|
Implements | osid.OsidObject | ||
osid.Temporal | |||
Description |
A | ||
Method | getResourceId | ||
Description |
Gets the resource | ||
Return | osid.id.Id | the resource Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getResource | ||
Description |
Gets the resource. | ||
Return | osid.resource.Resource | the resource | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | hasCustomer | ||
Description |
Tests if this payer is linked directly to a customer account. | ||
Return | boolean | true if this payer is linked to a customer, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCustomerId | ||
Description |
Gets the customer | ||
Return | osid.id.Id | the customer Id | |
Errors | ILLEGAL_STATE | hasCustomer() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getCustomer | ||
Description |
Gets the customer. | ||
Return | osid.billing.Customer | the customer | |
Errors | ILLEGAL_STATE | hasCustomer() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | usesActivity | ||
Description |
Tests if this payer uses the customer financial
activity for payments. If | ||
Return | boolean | true if this payer uses the customer activity, false
otherwise | |
Errors | ILLEGAL_STATE | hasCustomer() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | usesCash | ||
Description |
Tests if this payer uses cash for payments. | ||
Return | boolean | true if this payer uses the cash, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | hasCreditCard | ||
Description |
Tests if this payer pays by credit card. If | ||
Return | boolean | true if this payer pays by credit card, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCreditCardNumber | ||
Description |
Gets the credit card number. | ||
Return | string | the credit card number | |
Errors | ILLEGAL_STATE | hasCreditCard() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getCreditCardExpiration | ||
Description |
Gets the credit card expiration date. | ||
Return | osid.calendaring.DateTime | the expiration date | |
Errors | ILLEGAL_STATE | hasCreditCard() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getCreditCardCode | ||
Description |
Gets the credit card security code. | ||
Return | string | the credit card security code | |
Errors | ILLEGAL_STATE | hasCreditCard() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | hasBankAccount | ||
Description |
Tests if this payer pays by bank account If | ||
Return | boolean | true if this payer pays by bank account, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBankRoutingNumber | ||
Description |
Gets the bank routing number. | ||
Return | string | the bank routing number number | |
Errors | ILLEGAL_STATE | hasBankAccount() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getBankAccountNumber | ||
Description |
Gets the bank account number. | ||
Return | string | the bank account number | |
Errors | ILLEGAL_STATE | hasBankAccount() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getPayerRecord | ||
Description |
Gets the payer record corresponding to the given | ||
Parameters | osid.type.Type | payerRecordType | the type of payer record to retrieve |
Return | osid.billing.payment.records.PayerRecord | the payer record | |
Errors | NULL_ARGUMENT | payerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(payerRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |