Package com.funnelback.publicui.search.model.curator.action

Class DisplayMessage

  • All Implemented Interfaces:
    Action, HasNoBeans
    public final class DisplayMessage
extends java.lang.Object
implements Action, HasNoBeans
    Action to display the specified message within the search results.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface com.funnelback.publicui.search.model.curator.config.Action

        Action.Phase

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private Message message
      The message to display when this action is performed.

    • Constructor Summary

      Constructors 
      Constructor Description
      DisplayMessage()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void configure​(Configurer configurer)
      Configure this action (expected to autowire in any dependencies)
      boolean equals​(java.lang.Object o)  
      Message getMessage()
      The message to display when this action is performed.
      int hashCode()  
      void performAction​(SearchTransaction searchTransaction, Action.Phase phase)
      Add the given message to the curator model's exhibits in the given searchTransaction.
      boolean runsInPhase​(Action.Phase phase)
      Messages are added only in the output phase (once the response object has been created from Padre's output).
      void setMessage​(Message message)
      The message to display when this action is performed.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • message

        private Message message
        The message to display when this action is performed.

    • Constructor Detail

      • DisplayMessage

        public DisplayMessage()

    • Method Detail

      • performAction

        public void performAction​(SearchTransaction searchTransaction,
                          Action.Phase phase)
        Add the given message to the curator model's exhibits in the given searchTransaction.
        Specified by:
        performAction in interface Action
        Parameters:
        searchTransaction - Current search transaction
        phase - The phase being processed (Some actions may wish to behave differently depending on the current phase of processing).

      • runsInPhase

        public boolean runsInPhase​(Action.Phase phase)
        Messages are added only in the output phase (once the response object has been created from Padre's output).
        Specified by:
        runsInPhase in interface Action
        Parameters:
        phase - The phase being processed (Some actions may wish to behave differently depending on the current phase of processing).
        Returns:
        true if this action should be run in the given phase, otherwise return false.

      • configure

        public void configure​(Configurer configurer)
        Configure this action (expected to autowire in any dependencies)
        Specified by:
        configure in interface Action

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getMessage

        public Message getMessage()
        The message to display when this action is performed.

      • setMessage

        public void setMessage​(Message message)
        The message to display when this action is performed.