OSID - osid.repository.CompositionQuery Service Interface Definition

Interface	osid.repository.CompositionQuery
Implements	`osid.OsidObjectQuery`
	`osid.OsidContainableQuery`
	`osid.OsidOperableQuery`
	`osid.OsidSourceableQuery`
Description	This is the query for searching compositions. Each method specifies an `AND` term while multiple invocations of the same method produces a nested `OR.`
Method	matchAssetId
Description	Sets the asset `Id` for this query.
Parameters	`osid.id.Id`	`assetId`	the asset `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assetId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssetIdTerms
Description	Clears the asset `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetQuery
Description	Tests if an `AssetQuery` is available.
Return	`boolean`		`true` if an asset query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssetQuery
Description	Gets the query for an asset. Multiple retrievals produce a nested `OR` term.
Return	`osid.repository.AssetQuery`		the asset query
Errors	UNIMPLEMENTED		`supportsAssetQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAssetQuery()` is `true.`
Method	matchAnyAsset
Description	Matches compositions that has any asset mapping.
Parameters	`boolean`	`match`	`true` to match compositions with any asset, `false` to match compositions with no asset
Compliance	`mandatory`		This method must be implemented.
Method	clearAssetTerms
Description	Clears the asset terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchContainingCompositionId
Description	Sets the composition `Id` for this query to match compositions that have the specified composition as an ancestor.
Parameters	`osid.id.Id`	`compositionId`	a 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	clearContainingCompositionIdTerms
Description	Clears the containing composition `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsContainingCompositionQuery
Description	Tests if an `CompositionQuery` is available.
Return	`boolean`		`true` if a composition query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getContainingCompositionQuery
Description	Gets the query for a composition. Multiple retrievals produce a nested `OR` term.
Return	`osid.repository.CompositionQuery`		the composition query
Errors	UNIMPLEMENTED		`supportsContainingCompositionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContainingCompositionQuery()` is `true.`
Method	matchAnyContainingComposition
Description	Matches compositions with any ancestor.
Parameters	`boolean`	`match`	`true` to match composition with any ancestor, `false` to match root compositions
Compliance	`mandatory`		This method must be implemented.
Method	clearContainingCompositionTerms
Description	Clears the containing composition terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchContainedCompositionId
Description	Sets the composition `Id` for this query to match compositions that contain the specified composition.
Parameters	`osid.id.Id`	`compositionId`	a 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	clearContainedCompositionIdTerms
Description	Clears the contained composition `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsContainedCompositionQuery
Description	Tests if an `CompositionQuery` is available.
Return	`boolean`		`true` if a composition query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getContainedCompositionQuery
Description	Gets the query for a composition. Multiple retrievals produce a nested `OR` term.
Return	`osid.repository.CompositionQuery`		the composition query
Errors	UNIMPLEMENTED		`supportsContainedCompositionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContainedCompositionQuery()` is `true.`
Method	matchAnyContainedComposition
Description	Matches compositions that contain any other compositions.
Parameters	`boolean`	`match`	`true` to match composition with any descendant, `false` to match leaf compositions
Compliance	`mandatory`		This method must be implemented.
Method	clearContainedCompositionTerms
Description	Clears the contained composition terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRepositoryId
Description	Sets the repository `Id` for this query.
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` 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 queries can be retrieved for 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 terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionQueryRecord
Description	Gets the composition query record corresponding to the given `Composition` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`compositionRecordType`	a composition record type
Return	`osid.repository.records.CompositionQueryRecord`		the composition query record
Errors	NULL_ARGUMENT		`compositionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(compositionRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.