OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
repository package
Version 3.0.0
Release Candidate Preview
| Interface | osid.repository.CompositionQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidContainableQueryInspector | |||
osid.OsidOperableQueryInspector | |||
osid.OsidSourceableQueryInspector | |||
| Description |
This is the query inspector for examining composition queries. | ||
| Method | getAssetIdTerms | ||
| Description |
Gets the asset | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetTerms | ||
| Description |
Gets the asset query terms. | ||
| Return | osid.repository.AssetQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContainingCompositionIdTerms | ||
| Description |
Gets the containing composition | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContainingCompositionTerms | ||
| Description |
Gets the containing composition query terms. | ||
| Return | osid.repository.CompositionQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContainedCompositionIdTerms | ||
| Description |
Gets the contained composition | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContainedCompositionTerms | ||
| Description |
Gets the contained composition query terms. | ||
| Return | osid.repository.CompositionQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRepositoryIdTerms | ||
| Description |
Gets the repository | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRepositoryTerms | ||
| Description |
Gets the repository query terms. | ||
| Return | osid.repository.RepositoryQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCompositionQueryInspectorRecord | ||
| Description |
Gets the composition query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | compositionRecordType | a composition record type |
| Return | osid.repository.records.CompositionQueryInspectorRecord | the composition query inspector 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. | |