org.osid.ontology.batch

Interface RelevancyBatchForm

All Superinterfaces:

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

public interface RelevancyBatchForm
extends RelevancyForm

This is the form for creating and updating relevancies in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RelevancyBatchAdminSession. 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
Id	getMappedId() Gets the mapped Id of the relevancy if this is a create transaction.
Id	getRelevancyId() Gets the Id of the relevancy to be updated if this is an update transaction.
Id	getSubjectId() Gets the Subject Id of the relevancy if this is a create transaction.

Methods inherited from interface org.osid.ontology.RelevancyForm

getRelevancyFormRecord

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

getSubjectId

Id getSubjectId()

Gets the Subject Id of the relevancy if this is a create transaction.

Returns:

the subject Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getMappedId

Id getMappedId()

Gets the mapped Id of the relevancy if this is a create transaction.

Returns:

the mapped Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getRelevancyId

Id getRelevancyId()

Gets the Id of the relevancy to be updated if this is an update transaction.

Returns:

the relevancy Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.