Package com.tietoenator.trip.jxp.session
Class TdbBackgroundTaskSink
java.lang.Object
com.tietoenator.trip.jxp.session.TdbSessionObject
com.tietoenator.trip.jxp.TdbMessageProvider
com.tietoenator.trip.jxp.session.TdbBackgroundTaskSink
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 Summary
Modifier and TypeMethodDescriptionfiles()
Retrieve the list of file names (logfiles) associated with the sink eventmessages()
Retrieve the list of completion messages associated with the sink eventvoid
poll()
Poll the server for any updatesabstract void
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.Methods inherited from class com.tietoenator.trip.jxp.TdbMessageProvider
codeList, getLastCode, getLastMessage, hasMessages, messageList, resetMessages
Methods inherited from class com.tietoenator.trip.jxp.session.TdbSessionObject
cancel, getSession, isCancelable, setCancelable
-
Method Details
-
messages
Retrieve the list of completion messages associated with the sink event- Returns:
- The list of available completion messages
-
files
Retrieve the list of file names (logfiles) associated with the sink event- Returns:
- The list of available logfile names
-
poll
Poll the server for any updates- Throws:
TdbException
-
taskCompleted
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
-