OSID Logo
OSID Specifications
billing payment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.payment.PayerForm
Implementsosid.OsidObjectForm
osid.OsidTemporalForm
Description

This is the form for creating and updating Payers. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PayerAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetCustomerMetadata
Description

Gets the metadata for an customer.

Returnosid.Metadatametadata for the customer
CompliancemandatoryThis method must be implemented.
MethodsetCustomer
Description

Sets the customer.

Parametersosid.id.IdcustomerIdthe new customer
ErrorsINVALID_ARGUMENT customerId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT customerId is null
CompliancemandatoryThis method must be implemented.
MethodclearCustomer
Description

Removes the customer.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetUsesActivityMetadata
Description

Gets the metadata for a financial activity based payer.

Returnosid.Metadatametadata for the activity flag
CompliancemandatoryThis method must be implemented.
MethodsetUsesActivity
Description

Sets the activity flag.

Parametersbooleanactivitythe new activity flag
ErrorsINVALID_ARGUMENT activity is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearUsesActivity
Description

Removes the activity flag.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetUsesCashMetadata
Description

Gets the metadata for a cash payer.

Returnosid.Metadatametadata for the cash flag
CompliancemandatoryThis method must be implemented.
MethodsetUsesCash
Description

Sets the cash flag.

Parametersbooleancashthe new cash flag
ErrorsINVALID_ARGUMENT cash is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearUsesCash
Description

Removes the cash flag.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetCreditCardNumberMetadata
Description

Gets the metadata for the credit card number.

Returnosid.Metadatametadata for the credit card number
CompliancemandatoryThis method must be implemented.
MethodsetCreditCardNumber
Description

Sets the credit card number.

Parametersstringnumberthe new number
ErrorsINVALID_ARGUMENT number is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT number is null
CompliancemandatoryThis method must be implemented.
MethodclearCreditCardNumber
Description

Clears the credit card number.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetCreditCardExpirationMetadata
Description

Gets the metadata for the credit card expiration.

Returnosid.Metadatametadata for the credit card expiration
CompliancemandatoryThis method must be implemented.
MethodsetCreditCardExpiration
Description

Sets the credit card expiration.

Parametersosid.calendaring.DateTimedatethe new expiration date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearCreditCardExpiration
Description

Clears the credit card expiration.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetCreditCardCodeMetadata
Description

Gets the metadata for the credit card code.

Returnosid.Metadatametadata for the credit card code
CompliancemandatoryThis method must be implemented.
MethodsetCreditCardCode
Description

Sets the credit card code.

Parametersstringcodethe new code
ErrorsINVALID_ARGUMENT code is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT code is null
CompliancemandatoryThis method must be implemented.
MethodclearCreditCardCode
Description

Clears the credit card code.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetBankRoutingNumberMetadata
Description

Gets the metadata for the bank routing number.

Returnosid.Metadatametadata for the bank routing number
CompliancemandatoryThis method must be implemented.
MethodsetBankRoutingNumber
Description

Sets the bank routing number.

Parametersstringnumberthe new number
ErrorsINVALID_ARGUMENT number is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT number is null
CompliancemandatoryThis method must be implemented.
MethodclearBankRoutingNumber
Description

Clears the bank routing number.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetBankAccountNumberMetadata
Description

Gets the metadata for the bank account number.

Returnosid.Metadatametadata for the bank account number
CompliancemandatoryThis method must be implemented.
MethodsetBankAccountNumber
Description

Sets the bank account number.

Parametersstringnumberthe new number
ErrorsINVALID_ARGUMENT number is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT number is null
CompliancemandatoryThis method must be implemented.
MethodclearBankAccountNumber
Description

Clears the bank account number.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetPayerFormRecord
Description

Gets the PayerFormRecord corresponding to the given payer record Type.

Parametersosid.type.TypepayerRecordTypea payer record type
Returnosid.billing.payment.records.PayerFormRecordthe payer form record
ErrorsNULL_ARGUMENT payerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(payerRecordType) is false
CompliancemandatoryThis method must be implemented.