org.osid.acknowledgement

Interface CreditForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

CreditBatchForm

public interface CreditForm
extends OsidRelationshipForm

This is the form for creating and updating Credit objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the CreditAdminSession. 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
CreditFormRecord	getCreditFormRecord(Type creditRecordType) Gets the CreditFormRecord interface corresponding to the given credit 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

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getCreditFormRecord

CreditFormRecord getCreditFormRecord(Type creditRecordType)
                                     throws OperationFailedException

Gets the CreditFormRecord interface corresponding to the given credit record Type.

Parameters:

creditRecordType - the credit record type

Returns:

the record

Throws:

NullArgumentException - creditRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(creditRecordType) is false

Compliance:

mandatory - This method must be implemented.