org.osid.relationship

Interface Relationship

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface Relationship
extends OsidRelationship

A Relationship is an object between two peers. The genus type indicates the relationship between the peer and the related peer.

Method Summary

Methods

Modifier and Type	Method and Description
Id	getDestinationId() Gets the to peer Id in this relationship.
RelationshipRecord	getRelationshipRecord(Type relationshipRecordType) Gets the relationshop record corresponding to the given Relationship record Type.
Id	getSourceId() Gets the from peer Id in this relationship.

Methods inherited from interface org.osid.OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getSourceId

Id getSourceId()

Gets the from peer Id in this relationship.

Returns:

the peer

Compliance:

mandatory - This method must be implemented.

getDestinationId

Id getDestinationId()

Gets the to peer Id in this relationship.

Returns:

the related peer

Compliance:

mandatory - This method must be implemented.

getRelationshipRecord

RelationshipRecord getRelationshipRecord(Type relationshipRecordType)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets the relationshop record corresponding to the given Relationship record Type. This method is used to retrieve an object implementing the requested record. The relationshipRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(relationshipRecordType) is true .

Parameters:

relationshipRecordType - the type of relationship record to retrieve

Returns:

the relationship record

Throws:

NullArgumentException - relationshipRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(relationshipRecordType) is false

Compliance:

mandatory - This method must be implemented.