Interface PressQuery

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

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

Like all OsidQueries, PressQuery is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • matchTextId

      void matchTextId(Id textId, boolean match)
      Sets the text Id for this query to match presses that have a related affiliation.
      Parameters:
      textId - a text Id
      match - true if a positive match, false for negative match
      Throws:
      NullArgumentException - textId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTextIdTerms

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

    • supportsTextQuery

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

    • getTextQuery

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

    • matchAnyText

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

    • clearTextTerms

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

    • matchIdiomId

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

    • clearIdiomIdTerms

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

    • supportsIdiomQuery

      boolean supportsIdiomQuery()
      Tests if a IdiomQuery is available.
      Returns:
      true if an idiom query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getIdiomQuery

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

    • matchAnyIdiom

      void matchAnyIdiom(boolean match)
      Matches action groups with any idiom.
      Parameters:
      match - true to match presses with any idiom, false to match presses with no idiom
      Compliance:
      mandatory - This method must be implemented.

    • clearIdiomTerms

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

    • matchParameterId

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

    • clearParameterIdTerms

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

    • supportsParameterQuery

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

    • getParameterQuery

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

    • matchAnyParameter

      void matchAnyParameter(boolean match)
      Matches presses with any parameter.
      Parameters:
      match - true to match presses with any parameter, false to match presses with no parameter
      Compliance:
      mandatory - This method must be implemented.

    • clearParameterTerms

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

    • matchAncestorPressId

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

    • clearAncestorPressIdTerms

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

    • supportsAncestorPressQuery

      boolean supportsAncestorPressQuery()
      Tests if a PressQuery is available.
      Returns:
      true if an press query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorPressQuery

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

    • matchAnyAncestorPress

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

    • clearAncestorPressTerms

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

    • matchDescendantPressId

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

    • clearDescendantPressIdTerms

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

    • supportsDescendantPressQuery

      boolean supportsDescendantPressQuery()
      Tests if a PressQuery is available.
      Returns:
      true if an press query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantPressQuery

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

    • matchAnyDescendantPress

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

    • clearDescendantPressTerms

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

    • getPressQueryRecord

      PressQueryRecord getPressQueryRecord(Type pressRecordType) throws OperationFailedException
      Gets the press query record corresponding to the given Press record Type.Multiple record retrievals produce a nested OR term.
      Parameters:
      pressRecordType - a press record type
      Returns:
      the press query record
      Throws:
      NullArgumentException - pressRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(pressRecordType) is false
      Compliance:
      mandatory - This method must be implemented.