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

MethodmatchRuledCompositionId
Description

Matches enablers mapped to the composition.

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

Clears the composition Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledCompositionQuery
Description

Tests if a CompositionQuery is available.

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

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

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

Matches enablers mapped to any composition.

Parametersbooleanmatch true for enablers mapped to any composition, false to match enablers mapped to no composition
CompliancemandatoryThis method must be implemented.
MethodclearRuledCompositionTerms
Description

Clears the composition query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRepositoryId
Description

Matches enablers mapped to the composition.

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 query 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 retrievals produce 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 query terms.

CompliancemandatoryThis method must be implemented.
MethodgetCompositionEnablerQueryRecord
Description

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

Parametersosid.type.TypecompositionEnablerRecordTypea composition enabler record type
Returnosid.repository.rules.records.CompositionEnablerQueryRecordthe composition enabler query record
ErrorsNULL_ARGUMENT compositionEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(compositionEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.