OSID Specifications
transport package
Version 3.1.0
transport package
Version 3.1.0
| Interface | osid.transport.EndpointQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Used By | osid.transport.EndpointQueryInspector | ||
osid.transport.EndpointSearchResults | |||
| Description |
This is the query inspector for examining endpoint queries. | ||
| Method | getResourceIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceTerms | ||
| Description |
Gets the resource query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorEndpointIdTerms | ||
| Description |
Gets the ancestor endpoint | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorEndpointTerms | ||
| Description |
Gets the ancestor endpoint query terms. | ||
| Return | osid.transport.EndpointQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantEndpointIdTerms | ||
| Description |
Gets the descendant endpoint | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantEndpointTerms | ||
| Description |
Gets the descendant endpoint query terms. | ||
| Return | osid.transport.EndpointQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEndpointQueryInspectorRecord | ||
| Description |
Gets the endpoint query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | endpointRecordType | a endpoint record type |
| Return | osid.transport.records.EndpointQueryInspectorRecord | the endpoint query inspector record | |
| Errors | NULL_ARGUMENT | endpointRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(endpointRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |