OSID Logo
OSID Specifications
resource package
Version 3.1.0
Interfaceosid.resource.ResourceRelationship
Implementsosid.OsidRelationship
Used Byosid.resource.ResourceRelationshipAdminSession
osid.resource.ResourceRelationshipList
osid.resource.ResourceRelationshipLookupSession
Description

ResourceRelationship relates two resources.

MethodgetSourceResourceId
Description

Gets the source resource Id.

Returnosid.id.Id a resource Id
Compliancemandatory This method must be implemented.
MethodgetSourceResource
Description

Gets the Resource.

Returnosid.resource.Resource the source resource
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetDestinationResourceId
Description

Gets the destination resource Id.

Returnosid.id.Id a resource Id
Compliancemandatory This method must be implemented.
MethodgetDestinationResource
Description

Gets the Resource.

Returnosid.resource.Resource the destination resource
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This 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.TyperesourceRelationshipRecordType the type of the record to retrieve
Returnosid.resource.records.ResourceRelationshipRecord the resource relationship record
ErrorsNULL_ARGUMENT resourceRelationshipRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(resourceRelationshipRecordType) is false
Compliancemandatory This method must be implemented.