Interface | osid.billing.payment.PayerForm | ||
---|---|---|---|
Implements | osid.OsidObjectForm | ||
osid.OsidTemporalForm | |||
Description |
This is the form for creating and updating | ||
Method | getCustomerMetadata | ||
Description |
Gets the metadata for an customer. | ||
Return | osid.Metadata | metadata for the customer | |
Compliance | mandatory | This method must be implemented. | |
Method | setCustomer | ||
Description |
Sets the customer. | ||
Parameters | osid.id.Id | customerId | the new customer |
Errors | INVALID_ARGUMENT | customerId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | customerId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCustomer | ||
Description |
Removes the customer. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getUsesActivityMetadata | ||
Description |
Gets the metadata for a financial activity based payer. | ||
Return | osid.Metadata | metadata for the activity flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setUsesActivity | ||
Description |
Sets the activity flag. | ||
Parameters | boolean | activity | the new activity flag |
Errors | INVALID_ARGUMENT | activity is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearUsesActivity | ||
Description |
Removes the activity flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getUsesCashMetadata | ||
Description |
Gets the metadata for a cash payer. | ||
Return | osid.Metadata | metadata for the cash flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setUsesCash | ||
Description |
Sets the cash flag. | ||
Parameters | boolean | cash | the new cash flag |
Errors | INVALID_ARGUMENT | cash is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearUsesCash | ||
Description |
Removes the cash flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getCreditCardNumberMetadata | ||
Description |
Gets the metadata for the credit card number. | ||
Return | osid.Metadata | metadata for the credit card number | |
Compliance | mandatory | This method must be implemented. | |
Method | setCreditCardNumber | ||
Description |
Sets the credit card number. | ||
Parameters | string | number | the new number |
Errors | INVALID_ARGUMENT | number is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | number is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCreditCardNumber | ||
Description |
Clears the credit card number. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getCreditCardExpirationMetadata | ||
Description |
Gets the metadata for the credit card expiration. | ||
Return | osid.Metadata | metadata for the credit card expiration | |
Compliance | mandatory | This method must be implemented. | |
Method | setCreditCardExpiration | ||
Description |
Sets the credit card expiration. | ||
Parameters | osid.calendaring.DateTime | date | the new expiration date |
Errors | INVALID_ARGUMENT | date is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | date is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCreditCardExpiration | ||
Description |
Clears the credit card expiration. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getCreditCardCodeMetadata | ||
Description |
Gets the metadata for the credit card code. | ||
Return | osid.Metadata | metadata for the credit card code | |
Compliance | mandatory | This method must be implemented. | |
Method | setCreditCardCode | ||
Description |
Sets the credit card code. | ||
Parameters | string | code | the new code |
Errors | INVALID_ARGUMENT | code is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | code is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCreditCardCode | ||
Description |
Clears the credit card code. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getBankRoutingNumberMetadata | ||
Description |
Gets the metadata for the bank routing number. | ||
Return | osid.Metadata | metadata for the bank routing number | |
Compliance | mandatory | This method must be implemented. | |
Method | setBankRoutingNumber | ||
Description |
Sets the bank routing number. | ||
Parameters | string | number | the new number |
Errors | INVALID_ARGUMENT | number is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | number is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearBankRoutingNumber | ||
Description |
Clears the bank routing number. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getBankAccountNumberMetadata | ||
Description |
Gets the metadata for the bank account number. | ||
Return | osid.Metadata | metadata for the bank account number | |
Compliance | mandatory | This method must be implemented. | |
Method | setBankAccountNumber | ||
Description |
Sets the bank account number. | ||
Parameters | string | number | the new number |
Errors | INVALID_ARGUMENT | number is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | number is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearBankAccountNumber | ||
Description |
Clears the bank account number. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getPayerFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | payerRecordType | a payer record type |
Return | osid.billing.payment.records.PayerFormRecord | the payer form 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. |