Interface | osid.resource.BinQueryInspector | ||
---|---|---|---|
Implements | osid.OsidCatalogQueryInspector | ||
Description |
This is the query inspector for examining bin 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 | getAncestorBinIdTerms | ||
Description |
Gets the ancestor bin | ||
Return | osid.search.terms.IdTerm[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorBinTerms | ||
Description |
Gets the ancestor bin query terms. | ||
Return | osid.resource.BinQueryInspector[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantBinIdTerms | ||
Description |
Gets the descendant bin | ||
Return | osid.search.terms.IdTerm[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantBinTerms | ||
Description |
Gets the descendant bin query terms. | ||
Return | osid.resource.BinQueryInspector[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getBinQueryInspectorRecord | ||
Description |
Gets the bin query inspector record corresponding to
the given | ||
Parameters | osid.type.Type | binRecordType | a bin record type |
Return | osid.resource.records.BinQueryInspectorRecord | the bin query inspector record | |
Errors | NULL_ARGUMENT | binRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(binRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |