Interface | osid.billing.payment.PaymentForm | ||
---|---|---|---|
Implements | osid.OsidObjectForm | ||
Description |
This is the form for creating and updating | ||
Method | getPeriodMetadata | ||
Description |
Gets the metadata for the billing period. | ||
Return | osid.Metadata | metadata for the billing period | |
Compliance | mandatory | This method must be implemented. | |
Method | setPeriod | ||
Description |
Sets the period. | ||
Parameters | osid.id.Id | periodId | the new billing period |
Errors | INVALID_ARGUMENT | periodId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | periodId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearPeriod | ||
Description |
Clears the billing period. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getPaymentDateMetadata | ||
Description |
Gets the metadata for the payment date. | ||
Return | osid.Metadata | metadata for the payment date | |
Compliance | mandatory | This method must be implemented. | |
Method | setPaymentDate | ||
Description |
Sets the payment date. | ||
Parameters | osid.calendaring.DateTime | date | the new payment 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 | clearPaymentDate | ||
Description |
Clears the payment date. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcessDateMetadata | ||
Description |
Gets the metadata for the process date. | ||
Return | osid.Metadata | metadata for the procssed date | |
Compliance | mandatory | This method must be implemented. | |
Method | setProcessDate | ||
Description |
Sets the process date. | ||
Parameters | osid.calendaring.DateTime | date | the new process 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 | clearProcessDate | ||
Description |
Clears the process date. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getAmountMetadata | ||
Description |
Gets the metadata for the amount. | ||
Return | osid.Metadata | metadata for the amount | |
Compliance | mandatory | This method must be implemented. | |
Method | setAmount | ||
Description |
Sets the amount. | ||
Parameters | osid.financials.Currency | amount | the new amount |
Errors | INVALID_ARGUMENT | amount is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | amount is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearAmount | ||
Description |
Clears the amount. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getPaymentFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | paymentRecordType | a payment record type |
Return | osid.billing.payment.records.PaymentFormRecord | the payment form record | |
Errors | NULL_ARGUMENT | paymentRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(paymentRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |