org.osid.messaging

Interface ReceiptForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSubjugateableForm, Suppliable

All Known Subinterfaces:

ReceiptBatchForm

public interface ReceiptForm
extends OsidObjectForm, OsidSubjugateableForm

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

Method Summary

Methods

Modifier and Type	Method and Description
ReceiptFormRecord	getReceiptFormRecord(Type receiptRecordType) Gets the ReceiptFormRecord corresponding to the given Receipt record Type.

Methods inherited from interface org.osid.OsidObjectForm

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

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

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

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

getReceiptFormRecord

ReceiptFormRecord getReceiptFormRecord(Type receiptRecordType)
                                       throws OperationFailedException

Gets the ReceiptFormRecord corresponding to the given Receipt record Type.

Parameters:

receiptRecordType - the receipt record type

Returns:

the receipt form record

Throws:

NullArgumentException - receiptRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(receiptRecordType) is false

Compliance:

mandatory - This method must be implemented.