org.osid.ontology

Interface RelevancyForm

All Superinterfaces:

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

All Known Subinterfaces:

RelevancyBatchForm

public interface RelevancyForm
extends OsidRelationshipForm

This is the form for creating and updating Relevancy objects.

Method Summary

Methods

Modifier and Type	Method and Description
RelevancyFormRecord	getRelevancyFormRecord(Type relevancyRecordType) Gets the RelevancyFormRecord corresponding to the given relevancy 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

getRelevancyFormRecord

RelevancyFormRecord getRelevancyFormRecord(Type relevancyRecordType)
                                           throws OperationFailedException

Gets the RelevancyFormRecord corresponding to the given relevancy record Type.

Parameters:

relevancyRecordType - the relevancy record type

Returns:

the relevancy form record

Throws:

NullArgumentException - relevancyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(relevancyRecordType) is false

Compliance:

mandatory - This method must be implemented.