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 Details

    • 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.