org.osid.resource

Interface ResourceRelationshipQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface ResourceRelationshipQueryInspector
extends OsidRelationshipQueryInspector

This is the query inspector for examining resource relationship queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getBinIdTerms() Gets the bin Id query terms.
BinQueryInspector[]	getBinTerms() Gets the bin query terms.
IdTerm[]	getDestinationResourceIdTerms() Gets the Destination resource Id query terms.
ResourceQueryInspector[]	getDestinationResourceTerms() Gets the Destination resource query terms.
ResourceRelationshipQueryInspectorRecord	getResourceRelationshipQueryInspectorRecord(Type resourceRelationshipRecordType) Gets the resource relationship query inspector record corresponding to the given ResourceRelationship record Type.
BooleanTerm[]	getSameResourceTerms() Gets the same resource query terms.
IdTerm[]	getSourceResourceIdTerms() Gets the source resource Id query terms.
ResourceQueryInspector[]	getSourceResourceTerms() Gets the source resource query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getSourceResourceIdTerms

IdTerm[] getSourceResourceIdTerms()

Gets the source resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSourceResourceTerms

ResourceQueryInspector[] getSourceResourceTerms()

Gets the source resource query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDestinationResourceIdTerms

IdTerm[] getDestinationResourceIdTerms()

Gets the Destination resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDestinationResourceTerms

ResourceQueryInspector[] getDestinationResourceTerms()

Gets the Destination resource query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSameResourceTerms

BooleanTerm[] getSameResourceTerms()

Gets the same resource query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBinIdTerms

IdTerm[] getBinIdTerms()

Gets the bin Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBinTerms

BinQueryInspector[] getBinTerms()

Gets the bin query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getResourceRelationshipQueryInspectorRecord

ResourceRelationshipQueryInspectorRecord getResourceRelationshipQueryInspectorRecord(Type resourceRelationshipRecordType)
                                                                                     throws OperationFailedException

Gets the resource relationship query inspector record corresponding to the given ResourceRelationship record Type.

Parameters:

resourceRelationshipRecordType - a resource relationship record type

Returns:

the resource relationship query inspector record

Throws:

NullArgumentException - resourceRelationshipRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(resourceRelationshipRecordType) is false

Compliance:

mandatory - This method must be implemented.