Interface | osid.repository.rules.CompositionEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching composition enablers. Each
method match specifies an | ||
Method | matchRuledCompositionId | ||
Description |
Matches enablers mapped to the composition. | ||
Parameters | osid.id.Id | compositionId | the composition Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledCompositionQuery | ||
Description |
Tests if a | ||
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 | ||
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 |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRepositoryQuery | ||
Description |
Tests if a | ||
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 | ||
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 | ||
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. |