org.osid.resource

Interface ResourceRelationshipForm

All Superinterfaces:

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

All Known Subinterfaces:

ResourceRelationshipBatchForm

public interface ResourceRelationshipForm
extends OsidRelationshipForm

This is the form for creating and updating ResourceRelationships.

Method Summary

Methods

Modifier and Type	Method and Description
ResourceRelationshipFormRecord	getResourceRelationshipFormRecord(Type resourceRelationshipRecordType) Gets the ResourceRelationshipFormRecord record corresponding to the given relationship 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

getResourceRelationshipFormRecord

ResourceRelationshipFormRecord getResourceRelationshipFormRecord(Type resourceRelationshipRecordType)
                                                                 throws OperationFailedException

Gets the ResourceRelationshipFormRecord record corresponding to the given relationship Type.

Parameters:

resourceRelationshipRecordType - the resource relationship record type

Returns:

the resource relationship form record

Throws:

NullArgumentException - resourceRelationshipRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(resourceRelationshipRecordType) is false

Compliance:

mandatory - This method must be implemented.