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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

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.