Class SearchBlotterChannel

  • All Implemented Interfaces:
    com.caplin.datasource.blotter.BlotterChannel

    public class SearchBlotterChannel
    extends Object
    implements com.caplin.datasource.blotter.BlotterChannel
    • Constructor Detail

      • SearchBlotterChannel

        public SearchBlotterChannel​(com.caplin.datasource.DataSource dataSource,
                                    com.caplin.datasource.blotter.BlotterChannel blotterChannel)
    • Method Detail

      • publishTooManyResults

        public void publishTooManyResults​(String subject)
                                   throws com.fasterxml.jackson.core.JsonProcessingException

        Sends a status ok on the channel, with a message to inform the user there are too many results and they need to narrow down their search criteria.

        Parameters:
        subject - The subject of the search blotter.
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException
      • publishStatusEvent

        public void publishStatusEvent​(String subject,
                                       String status,
                                       String message)
                                throws com.fasterxml.jackson.core.JsonProcessingException

        Sends a status ok on the channel, with a JSON message consisting of a status and message.

        Under normal circumstances this method is not used.

        Parameters:
        subject - The subject of the search blotter.
        status - The status.
        message - The subject of the search blotter.
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException
      • closeChannel

        public void closeChannel()
        Specified by:
        closeChannel in interface com.caplin.datasource.blotter.BlotterChannel
      • getSubject

        public String getSubject()
        Specified by:
        getSubject in interface com.caplin.datasource.blotter.BlotterChannel
      • getUsername

        public String getUsername()
        Specified by:
        getUsername in interface com.caplin.datasource.blotter.BlotterChannel
      • getParameters

        public String getParameters()
        Specified by:
        getParameters in interface com.caplin.datasource.blotter.BlotterChannel
      • removeBlotterItem

        public void removeBlotterItem​(String uniqueId)
        Specified by:
        removeBlotterItem in interface com.caplin.datasource.blotter.BlotterChannel
      • removeBlotterItems

        public void removeBlotterItems​(List<String> uniqueIds)
        Specified by:
        removeBlotterItems in interface com.caplin.datasource.blotter.BlotterChannel
      • clear

        public void clear()
        Specified by:
        clear in interface com.caplin.datasource.blotter.BlotterChannel
      • sendBlotterItem

        public void sendBlotterItem​(com.caplin.datasource.blotter.BlotterItem item)
        Specified by:
        sendBlotterItem in interface com.caplin.datasource.blotter.BlotterChannel
      • sendBlotterItemNotFound

        public void sendBlotterItemNotFound​(String uniqueId)
        Specified by:
        sendBlotterItemNotFound in interface com.caplin.datasource.blotter.BlotterChannel
      • sendBlotterItems

        public void sendBlotterItems​(List<com.caplin.datasource.blotter.BlotterItem> items)
        Specified by:
        sendBlotterItems in interface com.caplin.datasource.blotter.BlotterChannel
      • sendBlotterMapping

        public void sendBlotterMapping​(String newSubject)
        Specified by:
        sendBlotterMapping in interface com.caplin.datasource.blotter.BlotterChannel
      • sendBlotterItemStatusOk

        public void sendBlotterItemStatusOk​(String uniqueId)
        Specified by:
        sendBlotterItemStatusOk in interface com.caplin.datasource.blotter.BlotterChannel
      • sendBlotterItemStatusStale

        public void sendBlotterItemStatusStale​(String uniqueId)
        Specified by:
        sendBlotterItemStatusStale in interface com.caplin.datasource.blotter.BlotterChannel
      • sendBlotterStatusOk

        public void sendBlotterStatusOk()
        Specified by:
        sendBlotterStatusOk in interface com.caplin.datasource.blotter.BlotterChannel
      • sendBlotterStatusStale

        public void sendBlotterStatusStale​(String message)
        Specified by:
        sendBlotterStatusStale in interface com.caplin.datasource.blotter.BlotterChannel
      • sendBlotterStatusOk

        public void sendBlotterStatusOk​(String message)
        Specified by:
        sendBlotterStatusOk in interface com.caplin.datasource.blotter.BlotterChannel
      • sendBlotterStatusStale

        public void sendBlotterStatusStale()
        Specified by:
        sendBlotterStatusStale in interface com.caplin.datasource.blotter.BlotterChannel
      • sendEmptyBlotter

        public void sendEmptyBlotter()
        Specified by:
        sendEmptyBlotter in interface com.caplin.datasource.blotter.BlotterChannel
      • setBlotterChannelListener

        public void setBlotterChannelListener​(com.caplin.datasource.blotter.BlotterChannelListener listener)
        Specified by:
        setBlotterChannelListener in interface com.caplin.datasource.blotter.BlotterChannel