OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.ResourceRelationship
Implementsosid.OsidRelationship
Description

ResourceRelationship relates two resources.

MethodgetSourceResourceId
Description

Gets the source resource Id.

Returnosid.id.Ida resource Id
CompliancemandatoryThis method must be implemented.
MethodgetSourceResource
Description

Gets the Resource.

Returnosid.resource.Resourcethe source resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetDestinationResourceId
Description

Gets the destination resource Id.

Returnosid.id.Ida resource Id
CompliancemandatoryThis method must be implemented.
MethodgetDestinationResource
Description

Gets the Resource.

Returnosid.resource.Resourcethe destination resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetResourceRelationshipRecord
Description

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

Parametersosid.type.TyperesourceRelationshipRecordTypethe type of the record to retrieve
Returnosid.resource.records.ResourceRelationshipRecordthe resource relationship record
ErrorsNULL_ARGUMENT resourceRelationshipRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(resourceRelationshipRecordType) is false
CompliancemandatoryThis method must be implemented.