OSID - osid.repository.rules.CompositionEnablerQuery Service Interface Definition

Interface	osid.repository.rules.CompositionEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.repository.rules.CompositionEnablerQuerySession`
	`osid.repository.rules.CompositionEnablerSearchSession`
	`osid.repository.rules.CompositionEnablerSmartRepositorySession`
Description	This is the query for searching composition enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledCompositionId
Description	Matches enablers mapped to the composition.
Parameters	`osid.id.Id`	`compositionId`	the composition `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`compositionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledCompositionIdTerms
Description	Clears the composition `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledCompositionQuery
Description	Tests if a `CompositionQuery` is available.
Return	`boolean`		`true` if a composition query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledCompositionQuery
Description	Gets the query for a composition. Multiple retrievals produce a nested `OR` term.
Return	`osid.repository.CompositionQuery`		the composition query
Errors	UNIMPLEMENTED		`supportsRuledCompositionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledCompositionQuery()` is `true`.
Method	matchAnyRuledComposition
Description	Matches enablers mapped to any composition.
Parameters	`boolean`	`match`	`true` for enablers mapped to any composition, `false` to match enablers mapped to no composition
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledCompositionTerms
Description	Clears the composition query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRepositoryId
Description	Matches enablers mapped to the composition.
Parameters	`osid.id.Id`	`repositoryId`	the repository `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`repositoryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRepositoryIdTerms
Description	Clears the repository `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRepositoryQuery
Description	Tests if a `RepositoryQuery` is available.
Return	`boolean`		`true` if a repository query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRepositoryQuery
Description	Gets the query for a repository. Multiple retrievals produce a nested `OR` term.
Return	`osid.repository.RepositoryQuery`		the repository query
Errors	UNIMPLEMENTED		`supportsRepositoryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRepositoryQuery()` is `true`.
Method	clearRepositoryTerms
Description	Clears the repository query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionEnablerQueryRecord
Description	Gets the composition enabler query record corresponding to the given `CompositionEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`compositionEnablerRecordType`	a composition enabler record type
Return	`osid.repository.rules.records.CompositionEnablerQueryRecord`		the composition enabler query record
Errors	NULL_ARGUMENT		`compositionEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(compositionEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.