OSID - osid.relationship.RelationshipQueryInspector Service Interface Definition

Interface	osid.relationship.RelationshipQueryInspector
Implements	`osid.OsidRelationshipQueryInspector`
Used By	`osid.OsidObjectQueryInspector`
	`osid.relationship.FamilyQueryInspector`
	`osid.relationship.RelationshipSearchResults`
	`osid.relationship.RelationshipSmartFamilySession`
	`osid.relationship.rules.RelationshipEnablerQueryInspector`
Description	This is the query inspector for examining relationship queries. Like all `OsidQueryInspectors`, `RelationshipQueryInspector` is stateful and must not be accessed by multiple processing threads.
Method	getSourceIdTerms
Description	Gets the peer `Id` terms.
Return	`osid.search.terms.IdTerm[]`		the peer `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getDestinationIdTerms
Description	Gets the other peer `Id` terms.
Return	`osid.search.terms.IdTerm[]`		the other peer `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getSamePeerIdTerms
Description	Gets the same peer terms.
Return	`osid.search.terms.BooleanTerm[]`		the same peer terms
Compliance	`mandatory`		This method must be implemented.
Method	getFamilyIdTerms
Description	Gets the family `Id` terms.
Return	`osid.search.terms.IdTerm[]`		the family `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getFamilyTerms
Description	Gets the family terms.
Return	`osid.relationship.FamilyQueryInspector[]`		the family terms
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipQueryInspectorRecord
Description	Gets the relationship query inspector record corresponding to the given `Relationship` record `Type`.
Parameters	`osid.type.Type`	`relationshipRecordType`	a relationship record type
Return	`osid.relationship.records.RelationshipQueryInspectorRecord`		the relationship query inspector record
Errors	NULL_ARGUMENT		`relationshipRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(relationshipRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.