OSID Specifications
resource package
Version 3.1.0
resource package
Version 3.1.0
| Interface | osid.resource.ResourceRelationshipQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Used By | osid.resource.ResourceQueryInspector | ||
osid.resource.ResourceRelationshipSearchResults | |||
osid.resource.ResourceRelationshipSmartBinSession | |||
| Description |
This is the query inspector for examining resource relationship queries. | ||
| Method | getSourceResourceIdTerms | ||
| Description |
Gets the source resource | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSourceResourceTerms | ||
| Description |
Gets the source resource query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDestinationResourceIdTerms | ||
| Description |
Gets the Destination resource | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDestinationResourceTerms | ||
| Description |
Gets the Destination resource query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSameResourceTerms | ||
| Description |
Gets the same resource query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | 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 | getResourceRelationshipQueryInspectorRecord | ||
| Description |
Gets the resource relationship query inspector record
corresponding to the given
| ||
| Parameters | osid.type.Type | resourceRelationshipRecordType | a resource relationship record type |
| Return | osid.resource.records.ResourceRelationshipQueryInspectorRecord | the resource relationship query inspector record | |
| Errors | NULL_ARGUMENT | resourceRelationshipRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(resourceRelationshipRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |