OSID Logo
OSID Specifications
relationship package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.RelationshipQueryInspector
Implementsosid.OsidRelationshipQueryInspector
Description

This is the query inspector for examining relationship queries.

MethodgetSourceIdTerms
Description

Gets the peer Id terms.

Returnosid.search.terms.IdTerm[]the peer Id terms
CompliancemandatoryThis method must be implemented.
MethodgetDestinationIdTerms
Description

Gets the other peer Id terms.

Returnosid.search.terms.IdTerm[]the other peer Id terms
CompliancemandatoryThis method must be implemented.
MethodgetSamePeerIdTerms
Description

Gets the same peer terms.

Returnosid.search.terms.BooleanTerm[]the same peer terms
CompliancemandatoryThis method must be implemented.
MethodgetFamilyIdTerms
Description

Gets the family Id terms.

Returnosid.search.terms.IdTerm[]the family Id terms
CompliancemandatoryThis method must be implemented.
MethodgetFamilyTerms
Description

Gets the family terms.

Returnosid.relationship.FamilyQueryInspector[]the family terms
CompliancemandatoryThis method must be implemented.
MethodgetRelationshipQueryInspectorRecord
Description

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

Parametersosid.type.TyperelationshipRecordTypea relationship record type
Returnosid.relationship.records.RelationshipQueryInspectorRecordthe relationship query inspector record
ErrorsNULL_ARGUMENT relationshipRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(relationshipRecordType) is false
CompliancemandatoryThis method must be implemented.