OSID - osid.relationship.RelationshipQuery Service Interface Definition

Interface	osid.relationship.RelationshipQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.OsidObjectQuery`
	`osid.relationship.FamilyQuery`
	`osid.relationship.RelationshipQuerySession`
	`osid.relationship.RelationshipSearchSession`
	`osid.relationship.RelationshipSmartFamilySession`
	`osid.relationship.rules.RelationshipEnablerQuery`
Description	This is the query for searching relationships. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchSourceId
Description	Matches a relationship peer.
Parameters	`osid.id.Id`	`peer`	peer `Id` to match
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`peer` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSourceIdTerms
Description	Clears the peer `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDestinationId
Description	Matches the other relationship peer.
Parameters	`osid.id.Id`	`peer`	peer `Id` to match
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`peer` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDestinationIdTerms
Description	Clears the other peer `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSamePeerId
Description	Matches circular relationships to the same peer.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearSamePeerIdTerms
Description	Clears the same peer `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFamilyId
Description	Sets the family `Id` for this query.
Parameters	`osid.id.Id`	`familyId`	a family `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`familyId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFamilyIdTerms
Description	Clears the family `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsFamilyQuery
Description	Tests if a `FamilyQuery` is available.
Return	`boolean`		`true` if a family query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFamilyQuery
Description	Gets the query for a family. Multiple retrievals produce a nested `OR` term.
Return	`osid.relationship.FamilyQuery`		the family query
Errors	UNIMPLEMENTED		`supportsFamilyQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFamilyQuery()` is `true`.
Method	clearFamilyTerms
Description	Clears the family terms.
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipQueryRecord
Description	Gets the relationship query record corresponding to the given `Relationship` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`relationshipRecordType`	a relationship record type
Return	`osid.relationship.records.RelationshipQueryRecord`		the relationship query 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.