OSID Logo
OSID Specifications
relationship package
Version 3.1.0
Interfaceosid.relationship.Relationship
Implementsosid.OsidRelationship
Used Byosid.relationship.RelationshipAdminSession
osid.relationship.RelationshipList
osid.relationship.RelationshipLookupSession
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.Id the peer
Compliancemandatory This method must be implemented.
MethodgetDestinationId
Description

Gets the to peer Id in this relationship.

Returnosid.id.Id the related peer
Compliancemandatory This 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.TyperelationshipRecordType the type of relationship record to retrieve
Returnosid.relationship.records.RelationshipRecord the relationship record
ErrorsNULL_ARGUMENT relationshipRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(relationshipRecordType) is false
Compliancemandatory This method must be implemented.