OSID Logo
OSID Specifications
relationship package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.Relationship
Implementsosid.OsidRelationship
Description

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

MethodgetSourceId
Description

Gets the from peer Id in this relationship.

Returnosid.id.Idthe peer
CompliancemandatoryThis method must be implemented.
MethodgetDestinationId
Description

Gets the to peer Id in this relationship.

Returnosid.id.Idthe related peer
CompliancemandatoryThis method must be implemented.
MethodgetRelationshipRecord
Description

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 .

Parametersosid.type.TyperelationshipRecordTypethe type of relationship record to retrieve
Returnosid.relationship.records.RelationshipRecordthe relationship record
ErrorsNULL_ARGUMENT relationshipRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(relationshipRecordType) is false
CompliancemandatoryThis method must be implemented.