Interface OublietteQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable
public interface OublietteQuery extends OsidCatalogQuery

This is the query for searching oubliettes. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • matchBlockId

      void matchBlockId(Id blockId, boolean match)
      Sets the effort Id for this query to match oubliettes containing blocks.
      Parameters:
      blockId - the block Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - blockId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearBlockIdTerms

      void clearBlockIdTerms()
      Clears the block query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsBlockQuery

      boolean supportsBlockQuery()
      Tests if a BlockQuery is available.
      Returns:
      true if a block query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBlockQuery

      BlockQuery getBlockQuery()
      Gets the query for a block. Multiple retrievals produce a nested OR term.
      Returns:
      the block query
      Throws:
      UnimplementedException - supportsBlockQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBlockQuery()} is {@code true} .

    • matchAnyBlock

      void matchAnyBlock(boolean match)
      Matches oubliettes that have any block.
      Parameters:
      match - true to match oubliettes with any block, false to match oubliettes with no block
      Compliance:
      mandatory - This method must be implemented.

    • clearBlockTerms

      void clearBlockTerms()
      Clears the block query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIssueId

      void matchIssueId(Id issueId, boolean match)
      Sets the issue Id for this query to match oubliettes that have a related issue.
      Parameters:
      issueId - an issue Id
      match - true if a positive match, false for negative match
      Throws:
      NullArgumentException - issueId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearIssueIdTerms

      void clearIssueIdTerms()
      Clears the issue Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsIssueQuery

      boolean supportsIssueQuery()
      Tests if an IssueQuery is available.
      Returns:
      true if an issue query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getIssueQuery

      IssueQuery getIssueQuery()
      Gets the query for an issue. Multiple retrievals produce a nested OR term.
      Returns:
      the issue query
      Throws:
      UnimplementedException - supportsIssueQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsIssueQuery()} is {@code true} .

    • matchAnyIssue

      void matchAnyIssue(boolean match)
      Matches oubliettes that have any issue.
      Parameters:
      match - true to match oubliettes with any issue, false to match oubliettes with no issue
      Compliance:
      mandatory - This method must be implemented.

    • clearIssueTerms

      void clearIssueTerms()
      Clears the issue query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchHoldId

      void matchHoldId(Id holdId, boolean match)
      Sets the hold Id for this query.
      Parameters:
      holdId - the hold Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - holdId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearHoldIdTerms

      void clearHoldIdTerms()
      Clears the hold Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsHoldQuery

      boolean supportsHoldQuery()
      Tests if a HoldQuery is available.
      Returns:
      true if a hold query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getHoldQuery

      HoldQuery getHoldQuery()
      Gets the query for a hold. Multiple retrievals produce a nested OR term.
      Returns:
      the hold query
      Throws:
      UnimplementedException - supportsHoldQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsHoldQuery()} is {@code true} .

    • matchAnyHold

      void matchAnyHold(boolean match)
      Matches oubliettes referenced by any hold.
      Parameters:
      match - true to match oubliettes with any holds, false to match oubliettes with no holds
      Compliance:
      mandatory - This method must be implemented.

    • clearHoldTerms

      void clearHoldTerms()
      Clears the hold query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAncestorOublietteId

      void matchAncestorOublietteId(Id oublietteId, boolean match)
      Sets the oubliette Id for this query to match oubliettes that have the specified oubliette as an ancestor.
      Parameters:
      oublietteId - an oubliette Id
      match - true for a positive match, false for negative match
      Throws:
      NullArgumentException - oublietteId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAncestorOublietteIdTerms

      void clearAncestorOublietteIdTerms()
      Clears the ancestor oubliette Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAncestorOublietteQuery

      boolean supportsAncestorOublietteQuery()
      Tests if an OublietteQuery is available.
      Returns:
      true if an oubliette query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorOublietteQuery

      OublietteQuery getAncestorOublietteQuery()
      Gets the query for an oubliette. Multiple retrievals produce a nested OR term.
      Returns:
      the oubliette query
      Throws:
      UnimplementedException - supportsAncestorOublietteQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAncestorOublietteQuery()} is {@code true} .

    • matchAnyAncestorOubliette

      void matchAnyAncestorOubliette(boolean match)
      Matches oubliettes with any ancestor.
      Parameters:
      match - true to match oubliettes with any ancestor, false to match root oubliettes
      Compliance:
      mandatory - This method must be implemented.

    • clearAncestorOublietteTerms

      void clearAncestorOublietteTerms()
      Clears the ancestor oubliette query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDescendantOublietteId

      void matchDescendantOublietteId(Id oublietteId, boolean match)
      Sets the oubliette Id for this query to match oubliettes that have the specified oubliette as a descendant.
      Parameters:
      oublietteId - an oubliette Id
      match - true for a positive match, false for negative match
      Throws:
      NullArgumentException - oublietteId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearDescendantOublietteIdTerms

      void clearDescendantOublietteIdTerms()
      Clears the descendant oubliette Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsDescendantOublietteQuery

      boolean supportsDescendantOublietteQuery()
      Tests if an OublietteQuery is available.
      Returns:
      true if an oubliette query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantOublietteQuery

      OublietteQuery getDescendantOublietteQuery()
      Gets the query for an oubliette/ Multiple retrievals produce a nested OR term.
      Returns:
      the oubliette query
      Throws:
      UnimplementedException - supportsDescendantOublietteQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDescendantOublietteQuery()} is {@code true} .

    • matchAnyDescendantOubliette

      void matchAnyDescendantOubliette(boolean match)
      Matches oubliettes with any descendant.
      Parameters:
      match - true to match oubliettes with any descendant, false to match leaf oubliettes
      Compliance:
      mandatory - This method must be implemented.

    • clearDescendantOublietteTerms

      void clearDescendantOublietteTerms()
      Clears the descendant oubliette query terms.
      Compliance:
      mandatory - This method must be implemented.

    • getOublietteQueryRecord

      OublietteQueryRecord getOublietteQueryRecord(Type oublietteRecordType) throws OperationFailedException, PermissionDeniedException
      Gets the oubliette query record corresponding to the given Oubliette record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      oublietteRecordType - an oubliette record type
      Returns:
      the oubliette query record
      Throws:
      NullArgumentException - oublietteRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - hasRecordType(oublietteRecordType) is false
      Compliance:
      mandatory - This method must be implemented.