OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
resource package
Version 3.0.0
Release Candidate Preview
| Interface | osid.resource.ResourceQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
| Description |
This is the query inspector for examining resource queries. | ||
| Method | getGroupTerms | ||
| Description |
Gets the group query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDemographicTerms | ||
| Description |
Gets the demographic query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContainingGroupIdTerms | ||
| Description |
Gets the containing group | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContainingGroupTerms | ||
| Description |
Gets the containing group query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAvatarIdTerms | ||
| Description |
Gets the asset | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAvatarTerms | ||
| Description |
Gets the asset query terms. | ||
| Return | osid.repository.AssetQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgentIdTerms | ||
| Description |
Gets the agent | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgentTerms | ||
| Description |
Gets the agent query terms. | ||
| Return | osid.authentication.AgentQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceRelationshipIdTerms | ||
| Description |
Gets the resource relationship | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceRelationshipTerms | ||
| Description |
Gets the resource relationship query terms. | ||
| Return | osid.resource.ResourceRelationshipQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBinIdTerms | ||
| Description |
Gets the bin | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBinTerms | ||
| Description |
Gets the bin query terms. | ||
| Return | osid.resource.BinQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceQueryInspectorRecord | ||
| Description |
Gets the record query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | resourceRecordType | a resource record type |
| Return | osid.resource.records.ResourceQueryInspectorRecord | the resource query inspector record | |
| Errors | NULL_ARGUMENT | resourceRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(resourceRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |