OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.CompositionQuery
Implementsosid.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.

MethodmatchAssetId
Description

Sets the asset Id for this query.

Parametersosid.id.IdassetIdthe asset Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT assetId is null
CompliancemandatoryThis method must be implemented.
MethodclearAssetIdTerms
Description

Clears the asset Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAssetQuery
Description

Tests if an AssetQuery is available.

Returnboolean true if an asset query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAssetQuery
Description

Gets the query for an asset. Multiple retrievals produce a nested OR term.

Returnosid.repository.AssetQuerythe asset query
ErrorsUNIMPLEMENTED supportsAssetQuery() is false
ComplianceoptionalThis method must be implemented if supportsAssetQuery() is true.
MethodmatchAnyAsset
Description

Matches compositions that has any asset mapping.

Parametersbooleanmatch true to match compositions with any asset, false to match compositions with no asset
CompliancemandatoryThis method must be implemented.
MethodclearAssetTerms
Description

Clears the asset terms.

CompliancemandatoryThis method must be implemented.
MethodmatchContainingCompositionId
Description

Sets the composition Id for this query to match compositions that have the specified composition as an ancestor.

Parametersosid.id.IdcompositionIda composition Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT compositionId is null
CompliancemandatoryThis method must be implemented.
MethodclearContainingCompositionIdTerms
Description

Clears the containing composition Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsContainingCompositionQuery
Description

Tests if an CompositionQuery is available.

Returnboolean true if a composition query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetContainingCompositionQuery
Description

Gets the query for a composition. Multiple retrievals produce a nested OR term.

Returnosid.repository.CompositionQuerythe composition query
ErrorsUNIMPLEMENTED supportsContainingCompositionQuery() is false
ComplianceoptionalThis method must be implemented if supportsContainingCompositionQuery() is true.
MethodmatchAnyContainingComposition
Description

Matches compositions with any ancestor.

Parametersbooleanmatch true to match composition with any ancestor, false to match root compositions
CompliancemandatoryThis method must be implemented.
MethodclearContainingCompositionTerms
Description

Clears the containing composition terms.

CompliancemandatoryThis method must be implemented.
MethodmatchContainedCompositionId
Description

Sets the composition Id for this query to match compositions that contain the specified composition.

Parametersosid.id.IdcompositionIda composition Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT compositionId is null
CompliancemandatoryThis method must be implemented.
MethodclearContainedCompositionIdTerms
Description

Clears the contained composition Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsContainedCompositionQuery
Description

Tests if an CompositionQuery is available.

Returnboolean true if a composition query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetContainedCompositionQuery
Description

Gets the query for a composition. Multiple retrievals produce a nested OR term.

Returnosid.repository.CompositionQuerythe composition query
ErrorsUNIMPLEMENTED supportsContainedCompositionQuery() is false
ComplianceoptionalThis method must be implemented if supportsContainedCompositionQuery() is true.
MethodmatchAnyContainedComposition
Description

Matches compositions that contain any other compositions.

Parametersbooleanmatch true to match composition with any descendant, false to match leaf compositions
CompliancemandatoryThis method must be implemented.
MethodclearContainedCompositionTerms
Description

Clears the contained composition terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRepositoryId
Description

Sets the repository Id for this query.

Parametersosid.id.IdrepositoryIdthe repository Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT repositoryId is null
CompliancemandatoryThis method must be implemented.
MethodclearRepositoryIdTerms
Description

Clears the repository Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRepositoryQuery
Description

Tests if a RepositoryQuery is available.

Returnboolean true if a repository query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRepositoryQuery
Description

Gets the query for a repository. Multiple queries can be retrieved for a nested OR term.

Returnosid.repository.RepositoryQuerythe repository query
ErrorsUNIMPLEMENTED supportsRepositoryQuery() is false
ComplianceoptionalThis method must be implemented if supportsRepositoryQuery() is true.
MethodclearRepositoryTerms
Description

Clears the repository terms.

CompliancemandatoryThis method must be implemented.
MethodgetCompositionQueryRecord
Description

Gets the composition query record corresponding to the given Composition record Type. Multiple retrievals produce a nested OR term.

Parametersosid.type.TypecompositionRecordTypea composition record type
Returnosid.repository.records.CompositionQueryRecordthe composition query record
ErrorsNULL_ARGUMENT compositionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(compositionRecordType) is false
CompliancemandatoryThis method must be implemented.