OSID - osid.relationship.rules.RelationshipEnablerQuery Service Interface Definition

Interface	osid.relationship.rules.RelationshipEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.relationship.rules.RelationshipEnablerQuerySession`
	`osid.relationship.rules.RelationshipEnablerSearchSession`
	`osid.relationship.rules.RelationshipEnablerSmartFamilySession`
Description	This is the query for searching relationship enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledRelationshipId
Description	Matches enablers mapped to the relationship.
Parameters	`osid.id.Id`	`relationshipId`	the relationship `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`relationshipId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledRelationshipIdTerms
Description	Clears the relationship `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledRelationshipQuery
Description	Tests if a `RelationshipQuery` is available.
Return	`boolean`		`true` if a relationship query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledRelationshipQuery
Description	Gets the query for a relationship. Multiple retrievals produce a nested `OR` term.
Return	`osid.relationship.RelationshipQuery`		the relationship query
Errors	UNIMPLEMENTED		`supportsRuledRelationshipQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledRelationshipQuery()` is `true`.
Method	matchAnyRuledRelationship
Description	Matches enablers mapped to any relationship.
Parameters	`boolean`	`match`	`true` for enablers mapped to any relationship, `false` to match enablers mapped to no relationship
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledRelationshipTerms
Description	Clears the relationship query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFamilyId
Description	Matches enablers mapped to a family.
Parameters	`osid.id.Id`	`familyId`	the 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` query 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 query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipEnablerQueryRecord
Description	Gets the relationship enabler query record corresponding to the given `RelationshipEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`relationshipEnablerRecordType`	a relationship enabler record type
Return	`osid.relationship.rules.records.RelationshipEnablerQueryRecord`		the relationship enabler query record
Errors	NULL_ARGUMENT		`relationshipEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(relationshipEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.