org.osid.resource

Interface BinQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface BinQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining bin queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorBinIdTerms() Gets the ancestor bin Id query terms.
BinQueryInspector[]	getAncestorBinTerms() Gets the ancestor bin query terms.
BinQueryInspectorRecord	getBinQueryInspectorRecord(Type binRecordType) Gets the bin query inspector record corresponding to the given Bin record Type.
IdTerm[]	getDescendantBinIdTerms() Gets the descendant bin Id query terms.
BinQueryInspector[]	getDescendantBinTerms() Gets the descendant bin query terms.
IdTerm[]	getResourceIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getResourceTerms() Gets the resource query terms.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

getResourceIdTerms

IdTerm[] getResourceIdTerms()

Gets the resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getResourceTerms

ResourceQueryInspector[] getResourceTerms()

Gets the resource query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorBinIdTerms

IdTerm[] getAncestorBinIdTerms()

Gets the ancestor bin Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorBinTerms

BinQueryInspector[] getAncestorBinTerms()

Gets the ancestor bin query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantBinIdTerms

IdTerm[] getDescendantBinIdTerms()

Gets the descendant bin Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantBinTerms

BinQueryInspector[] getDescendantBinTerms()

Gets the descendant bin query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBinQueryInspectorRecord

BinQueryInspectorRecord getBinQueryInspectorRecord(Type binRecordType)
                                                   throws OperationFailedException

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

Parameters:

binRecordType - a bin record type

Returns:

the bin query inspector record

Throws:

NullArgumentException - binRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(binRecordType) is false

Compliance:

mandatory - This method must be implemented.