OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.BinQueryInspector
Implementsosid.OsidCatalogQueryInspector
Description

This is the query inspector for examining bin queries.

MethodgetResourceIdTerms
Description

Gets the resource Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetResourceTerms
Description

Gets the resource query terms.

Returnosid.resource.ResourceQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorBinIdTerms
Description

Gets the ancestor bin Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorBinTerms
Description

Gets the ancestor bin query terms.

Returnosid.resource.BinQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantBinIdTerms
Description

Gets the descendant bin Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantBinTerms
Description

Gets the descendant bin query terms.

Returnosid.resource.BinQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetBinQueryInspectorRecord
Description

Gets the bin query inspector record corresponding to the given Bin record Type.

Parametersosid.type.TypebinRecordTypea bin record type
Returnosid.resource.records.BinQueryInspectorRecordthe bin query inspector record
ErrorsNULL_ARGUMENT binRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(binRecordType) is false
CompliancemandatoryThis method must be implemented.