org.osid.relationship

Interface RelationshipQueryInspector

All Superinterfaces:

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

public interface RelationshipQueryInspector
extends OsidRelationshipQueryInspector

This is the query inspector for examining relationship queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getDestinationIdTerms() Gets the other peer Id terms.
IdTerm[]	getFamilyIdTerms() Gets the family Id terms.
FamilyQueryInspector[]	getFamilyTerms() Gets the family terms.
RelationshipQueryInspectorRecord	getRelationshipQueryInspectorRecord(Type relationshipRecordType) Gets the relationship query inspector record corresponding to the given Relationship record Type.
BooleanTerm[]	getSamePeerIdTerms() Gets the same peer terms.
IdTerm[]	getSourceIdTerms() Gets the peer Id 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

getSourceIdTerms

IdTerm[] getSourceIdTerms()

Gets the peer Id terms.

Returns:

the peer Id terms

Compliance:

mandatory - This method must be implemented.

getDestinationIdTerms

IdTerm[] getDestinationIdTerms()

Gets the other peer Id terms.

Returns:

the other peer Id terms

Compliance:

mandatory - This method must be implemented.

getSamePeerIdTerms

BooleanTerm[] getSamePeerIdTerms()

Gets the same peer terms.

Returns:

the same peer terms

Compliance:

mandatory - This method must be implemented.

getFamilyIdTerms

IdTerm[] getFamilyIdTerms()

Gets the family Id terms.

Returns:

the family Id terms

Compliance:

mandatory - This method must be implemented.

getFamilyTerms

FamilyQueryInspector[] getFamilyTerms()

Gets the family terms.

Returns:

the family terms

Compliance:

mandatory - This method must be implemented.

getRelationshipQueryInspectorRecord

RelationshipQueryInspectorRecord getRelationshipQueryInspectorRecord(Type relationshipRecordType)
                                                                     throws OperationFailedException,
                                                                            PermissionDeniedException

Gets the relationship query inspector record corresponding to the given Relationship record Type.

Parameters:

relationshipRecordType - a relationship record type

Returns:

the relationship query inspector record

Throws:

NullArgumentException - relationshipRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(relationshipRecordType) is false

Compliance:

mandatory - This method must be implemented.