Interface ResourceRelationship

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface ResourceRelationship
extends OsidRelationship

ResourceRelationship relates two resources.

Method Summary

Modifier and Type	Method	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 Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type.

Methods inherited from interface OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Modifier and Type	Method	Description
State	getEndReason()	Gets a state indicating why this relationship has ended.
Id	getEndReasonId()	Gets a state Id indicating why this relationship has ended.
boolean	hasEndReason()	Tests if a reason this relationship came to an end is known.

Methods inherited from interface Temporal

getEndDate, getStartDate, isEffective

Modifier and Type	Method	Description
DateTime	getEndDate()	Gets the end date.
DateTime	getStartDate()	Gets the start date.
boolean	isEffective()	Tests if the current date is within the start end end dates inclusive.

Method Details

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.