Class TdbBackgroundTaskSink


  • public abstract class TdbBackgroundTaskSink
    extends TdbMessageProvider
    Define an object of this type to receive notification of the completion background tasks (e.g. print, index, etc.) To be informed when background tasks complete on the server, derive a new class from this base class and provide an object of that new class to the appropriate TdbSession using the BackgroundTaskSink property. When background tasks complete on the server, the TaskCompleted method of the new object will be invoked during the deserialization process of the server's response.
    • Method Detail

      • messages

        public java.util.List<java.lang.String> messages()
        Retrieve the list of completion messages associated with the sink event
        Returns:
        The list of available completion messages
      • files

        public java.util.List<java.lang.String> files()
        Retrieve the list of file names (logfiles) associated with the sink event
        Returns:
        The list of available logfile names
      • taskCompleted

        public abstract void taskCompleted()
                                    throws TdbException
        This abstract method must be overridden in concrete instantiations of this base class, and is called in the face of completion events from the server.
        Throws:
        TdbException