org.osid.installation

Interface DepotQueryInspector

All Superinterfaces:

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

public interface DepotQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining depot queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorDepotIdTerms() Gets the ancestor depot Id query terms.
DepotQueryInspector[]	getAncestorDepotTerms() Gets the ancestor depot query terms.
DepotQueryInspectorRecord	getDepotQueryInspectorRecord(Type depotRecordType) Gets the depot query inspector record corresponding to the given Depot record Type.
IdTerm[]	getDescendantDepotIdTerms() Gets the descendant depot Id query terms.
DepotQueryInspector[]	getDescendantDepotTerms() Gets the descendant depot query terms.
IdTerm[]	getPackageIdTerms() Gets the package Id query terms.
PackageQueryInspector[]	getPackageTerms() Gets the package 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

getPackageIdTerms

IdTerm[] getPackageIdTerms()

Gets the package Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPackageTerms

PackageQueryInspector[] getPackageTerms()

Gets the package query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorDepotIdTerms

IdTerm[] getAncestorDepotIdTerms()

Gets the ancestor depot Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorDepotTerms

DepotQueryInspector[] getAncestorDepotTerms()

Gets the ancestor depot query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantDepotIdTerms

IdTerm[] getDescendantDepotIdTerms()

Gets the descendant depot Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantDepotTerms

DepotQueryInspector[] getDescendantDepotTerms()

Gets the descendant depot query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDepotQueryInspectorRecord

DepotQueryInspectorRecord getDepotQueryInspectorRecord(Type depotRecordType)
                                                       throws OperationFailedException

Gets the depot query inspector record corresponding to the given Depot record Type.

Parameters:

depotRecordType - a depot record type

Returns:

the depot query inspector record

Throws:

NullArgumentException - depotRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(depotRecordType) is false

Compliance:

mandatory - This method must be implemented.