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

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.

MethodgetPeriodMetadata
Description

Gets the metadata for the billing period.

Returnosid.Metadatametadata for the billing period
CompliancemandatoryThis method must be implemented.
MethodsetPeriod
Description

Sets the period.

Parametersosid.id.IdperiodIdthe new billing period
ErrorsINVALID_ARGUMENT periodId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT periodId is null
CompliancemandatoryThis method must be implemented.
MethodclearPeriod
Description

Clears the billing period.

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

Gets the metadata for the payment date.

Returnosid.Metadatametadata for the payment date
CompliancemandatoryThis method must be implemented.
MethodsetPaymentDate
Description

Sets the payment date.

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

Clears the payment date.

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

Gets the metadata for the process date.

Returnosid.Metadatametadata for the procssed date
CompliancemandatoryThis method must be implemented.
MethodsetProcessDate
Description

Sets the process date.

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

Clears the process date.

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

Gets the metadata for the amount.

Returnosid.Metadatametadata for the amount
CompliancemandatoryThis method must be implemented.
MethodsetAmount
Description

Sets the amount.

Parametersosid.financials.Currencyamountthe new amount
ErrorsINVALID_ARGUMENT amount is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT amount is null
CompliancemandatoryThis method must be implemented.
MethodclearAmount
Description

Clears the amount.

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

Gets the PaymentFormRecord corresponding to the given payment record Type.

Parametersosid.type.TypepaymentRecordTypea payment record type
Returnosid.billing.payment.records.PaymentFormRecordthe payment form record
ErrorsNULL_ARGUMENT paymentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(paymentRecordType) is false
CompliancemandatoryThis method must be implemented.