org.osid.relationship.batch

Interface RelationshipBatchForm

All Superinterfaces:

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

public interface RelationshipBatchForm
extends RelationshipForm

This is the form for creating and updating relationships in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RelationshipBatchAdminSession. 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	getDestinationNodeId() Gets the Id of the destination node if this is a create transaction.
Id	getRelationshipId() Gets the Id of the relationship to be updated if this is an update transaction.
Id	getSourceNodeId() Gets the Id of the source node if this is a create transaction.

Methods inherited from interface org.osid.relationship.RelationshipForm

getRelationshipFormRecord

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

getSourceNodeId

Id getSourceNodeId()

Gets the Id of the source node if this is a create transaction.

Returns:

the node Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getDestinationNodeId

Id getDestinationNodeId()

Gets the Id of the destination node if this is a create transaction.

Returns:

the node Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getRelationshipId

Id getRelationshipId()

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

Returns:

the relationship Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.