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.
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. |
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getSourceId()
Id
in this relationship.mandatory
- This method must be implemented. Id getDestinationId()
Id
in this relationship.mandatory
- This method must be implemented. RelationshipRecord getRelationshipRecord(Type relationshipRecordType) throws OperationFailedException, PermissionDeniedException
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
.relationshipRecordType
- the type of relationship record to
retrieveNullArgumentException
- relationshipRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(relationshipRecordType)
is false
mandatory
- This method must be implemented.