Interface VaultQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
public interface VaultQueryInspector extends OsidCatalogQueryInspector

This is the query inspector for examining vault queries.

  • Method Details

    • getFunctionIdTerms

      IdTerm[] getFunctionIdTerms()
      Gets the function Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getFunctionTerms

      FunctionQueryInspector[] getFunctionTerms()
      Gets the function query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getQualifierIdTerms

      IdTerm[] getQualifierIdTerms()
      Gets the qualifier Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getQualifierTerms

      QualifierQueryInspector[] getQualifierTerms()
      Gets the qualifier query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationIdTerms

      IdTerm[] getAuthorizationIdTerms()
      Gets the authorization Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationTerms

      AuthorizationQueryInspector[] getAuthorizationTerms()
      Gets the authorization query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorVaultIdTerms

      IdTerm[] getAncestorVaultIdTerms()
      Gets the ancestor vault Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorVaultTerms

      VaultQueryInspector[] getAncestorVaultTerms()
      Gets the ancestor vault query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantVaultIdTerms

      IdTerm[] getDescendantVaultIdTerms()
      Gets the descendant vault Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantVaultTerms

      VaultQueryInspector[] getDescendantVaultTerms()
      Gets the descendant vault query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getVaultQueryInspectorRecord

      VaultQueryInspectorRecord getVaultQueryInspectorRecord(Type vaultRecordType) throws OperationFailedException
      Gets the vault query inspector record corresponding to the given Vault record Type .
      Parameters:
      vaultRecordType - a vault query inspector record type
      Returns:
      the vault query inspector record
      Throws:
      NullArgumentException - vaultRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(vaultRecordType) is false
      Compliance:
      mandatory - This method must be implemented.