Interface PaymentForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable
All Known Subinterfaces:
PaymentBatchForm
public interface PaymentForm extends OsidObjectForm

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

Like all OsidForms, PaymentForm is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getPeriodMetadata

      Metadata getPeriodMetadata()
      Gets the metadata for the billing period.
      Returns:
      metadata for the billing period
      Compliance:
      mandatory - This method must be implemented.

    • setPeriod

      void setPeriod(Id periodId)
      Sets the period.
      Parameters:
      periodId - the new billing period
      Throws:
      InvalidArgumentException - periodId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - periodId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearPeriod

      void clearPeriod()
      Clears the billing period.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getPaymentDateMetadata

      Metadata getPaymentDateMetadata()
      Gets the metadata for the payment date.
      Returns:
      metadata for the payment date
      Compliance:
      mandatory - This method must be implemented.

    • setPaymentDate

      void setPaymentDate(DateTime date)
      Sets the payment date.
      Parameters:
      date - the new payment date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearPaymentDate

      void clearPaymentDate()
      Clears the payment date.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getProcessDateMetadata

      Metadata getProcessDateMetadata()
      Gets the metadata for the process date.
      Returns:
      metadata for the procssed date
      Compliance:
      mandatory - This method must be implemented.

    • setProcessDate

      void setProcessDate(DateTime date)
      Sets the process date.
      Parameters:
      date - the new process date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearProcessDate

      void clearProcessDate()
      Clears the process date.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getAmountMetadata

      Metadata getAmountMetadata()
      Gets the metadata for the amount.
      Returns:
      metadata for the amount
      Compliance:
      mandatory - This method must be implemented.

    • setAmount

      void setAmount(Currency amount)
      Sets the amount.
      Parameters:
      amount - the new amount
      Throws:
      InvalidArgumentException - amount is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - amount is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAmount

      void clearAmount()
      Clears the amount.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getPaymentFormRecord

      PaymentFormRecord getPaymentFormRecord(Type paymentRecordType) throws OperationFailedException
      Gets the PaymentFormRecord corresponding to the given payment record Type.
      Parameters:
      paymentRecordType - a payment record type
      Returns:
      the payment form record
      Throws:
      NullArgumentException - paymentRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(paymentRecordType) is false
      Compliance:
      mandatory - This method must be implemented.