OSID Specifications
repository package
Version 3.1.0
repository package
Version 3.1.0
| Interface | osid.repository.RepositoryQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Used By | osid.repository.AssetQueryInspector | ||
osid.repository.CompositionQueryInspector | |||
osid.repository.RepositoryQueryInspector | |||
osid.repository.RepositorySearchResults | |||
osid.repository.rules.CompositionEnablerQueryInspector | |||
| Description |
This is the query inspector for examining repository 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 | getAssetContentIdTerms | ||
| Description |
Gets the asset content | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetContentTerms | ||
| Description |
Gets the asset content query terms. | ||
| Return | osid.repository.AssetContentQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCompositionIdTerms | ||
| Description |
Gets the composition | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCompositionTerms | ||
| Description |
Gets the composition query terms. | ||
| Return | osid.repository.CompositionQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorRepositoryIdTerms | ||
| Description |
Gets the ancestor repository | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorRepositoryTerms | ||
| Description |
Gets the ancestor repository query terms. | ||
| Return | osid.repository.RepositoryQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantRepositoryIdTerms | ||
| Description |
Gets the descendant repository | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantRepositoryTerms | ||
| Description |
Gets the descendant repository query terms. | ||
| Return | osid.repository.RepositoryQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRepositoryQueryInspectorRecord | ||
| Description |
Gets the repository query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | repositoryRecordType | a repository record type |
| Return | osid.repository.records.RepositoryQueryInspectorRecord | the repository query inspector record | |
| Errors | NULL_ARGUMENT | repositoryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(repositoryRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |