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

Modifier and Type	Method	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 Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type.

Methods inherited from interface OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Modifier and Type	Method	Description
State	getEndReason()	Gets a state indicating why this relationship has ended.
Id	getEndReasonId()	Gets a state Id indicating why this relationship has ended.
boolean	hasEndReason()	Tests if a reason this relationship came to an end is known.

Methods inherited from interface Temporal

getEndDate, getStartDate, isEffective

Modifier and Type	Method	Description
DateTime	getEndDate()	Gets the end date.
DateTime	getStartDate()	Gets the start date.
boolean	isEffective()	Tests if the current date is within the start end end dates inclusive.

Method Details

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.