org.osid.calendaring

Interface CommitmentForm

All Superinterfaces:

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

All Known Subinterfaces:

CommitmentBatchForm

public interface CommitmentForm
extends OsidRelationshipForm

This is the form for creating and updating Commitments.

Method Summary

Methods

Modifier and Type	Method and Description
CommitmentFormRecord	getCommitmentFormRecord(Type commitmentRecordType) Gets the CommitmentFormRecord corresponding to the given event 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

getCommitmentFormRecord

CommitmentFormRecord getCommitmentFormRecord(Type commitmentRecordType)
                                             throws OperationFailedException

Gets the CommitmentFormRecord corresponding to the given event record Type.

Parameters:

commitmentRecordType - the commitment record type

Returns:

the commitment form record

Throws:

NullArgumentException - commitmentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commitmentRecordType) is false

Compliance:

mandatory - This method must be implemented.