public interface PaymentForm extends OsidObjectForm
This is the form for creating and updating Payments.
Like all OsidForm
objects, 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.
Modifier and Type | Method and Description |
---|---|
void |
clearAmount()
Clears the amount.
|
void |
clearPaymentDate()
Clears the payment date.
|
void |
clearPeriod()
Clears the billing period.
|
void |
clearProcessDate()
Clears the process date.
|
Metadata |
getAmountMetadata()
Gets the metadata for the amount.
|
Metadata |
getPaymentDateMetadata()
Gets the metadata for the payment date.
|
PaymentFormRecord |
getPaymentFormRecord(Type paymentRecordType)
Gets the
PaymentFormRecord corresponding to the given
payment record Type. |
Metadata |
getPeriodMetadata()
Gets the metadata for the billing period.
|
Metadata |
getProcessDateMetadata()
Gets the metadata for the process date.
|
void |
setAmount(Currency amount)
Sets the amount.
|
void |
setPaymentDate(DateTime date)
Sets the payment date.
|
void |
setPeriod(Id periodId)
Sets the period.
|
void |
setProcessDate(DateTime date)
Sets the process date.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getPeriodMetadata()
mandatory
- This method must be implemented. void setPeriod(Id periodId)
periodId
- the new billing periodInvalidArgumentException
- periodId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- periodId
is
null
mandatory
- This method must be implemented. void clearPeriod()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getPaymentDateMetadata()
mandatory
- This method must be implemented. void setPaymentDate(DateTime date)
date
- the new payment dateInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearPaymentDate()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getProcessDateMetadata()
mandatory
- This method must be implemented. void setProcessDate(DateTime date)
date
- the new process dateInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearProcessDate()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getAmountMetadata()
mandatory
- This method must be implemented. void setAmount(Currency amount)
amount
- the new amountInvalidArgumentException
- amount
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- amount
is
null
mandatory
- This method must be implemented. void clearAmount()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. PaymentFormRecord getPaymentFormRecord(Type paymentRecordType) throws OperationFailedException
PaymentFormRecord
corresponding to the given
payment record Type.
paymentRecordType
- a payment record typeNullArgumentException
- paymentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(paymentRecordType)
is false
mandatory
- This method must be implemented.