org.osid.resource

Interface ResourceRelationship

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface ResourceRelationship
extends OsidRelationship

ResourceRelationship relates two resources.

Method Summary

Methods

Modifier and Type	Method and Description
Resource	getDestinationResource() Gets the Resource.
Id	getDestinationResourceId() Gets the destination resource Id.
ResourceRelationshipRecord	getResourceRelationshipRecord(Type resourceRelationshipRecordType) Gets the resource relationship record corresponding to the given ResourceRelationship record Type.
Resource	getSourceResource() Gets the Resource.
Id	getSourceResourceId() Gets the source resource Id.

Methods inherited from interface org.osid.OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getSourceResourceId

Id getSourceResourceId()

Gets the source resource Id.

Returns:

a resource Id

Compliance:

mandatory - This method must be implemented.

getSourceResource

Resource getSourceResource()
                           throws OperationFailedException

Gets the Resource.

Returns:

the source resource

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getDestinationResourceId

Id getDestinationResourceId()

Gets the destination resource Id.

Returns:

a resource Id

Compliance:

mandatory - This method must be implemented.

getDestinationResource

Resource getDestinationResource()
                                throws OperationFailedException

Gets the Resource.

Returns:

the destination resource

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getResourceRelationshipRecord

ResourceRelationshipRecord getResourceRelationshipRecord(Type resourceRelationshipRecordType)
                                                         throws OperationFailedException

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 .

Parameters:

resourceRelationshipRecordType - the type of the record to retrieve

Returns:

the resource relationship record

Throws:

NullArgumentException - resourceRelationshipRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(resourceRelationshipRecordType) is false

Compliance:

mandatory - This method must be implemented.