Interface INotificationListener
-
- All Known Implementing Classes:
DefaultNotificationListener
public interface INotificationListener
Listener can implement this interface to be notified on events.Listeners are called from a background thread which expects to get control back quickly. If a listener is going to perform a potentially time-consuming operation like processing a large document or doing something that may block, such as performing socket IO, it should arrange to do that work in another thread so it can return to its caller quickly.
Note: This interface may be extended with additional methods in future versions of the API. Instead of implementing this interface directly we suggest to extend
DefaultNotificationListener
instead. This has the advantage that your subclass does not need to be changed whenever a new method is added to theINotificationListener
interface.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
activationMessages(int runNumner, UC4ObjectName task, TranslatedMessage[] messages)
This method is called if there is an activation protocol for a task.void
activityListChanged()
Deprecated.useIKickEventListener
insteadvoid
asyncMessage(AsyncMessage message)
This method is called if a new message is available.void
handleIOException(java.io.IOException e)
This method is called if there was an I/O-error.void
highestCallOperatorChanged()
Deprecated.useIKickEventListener
insteadvoid
processingStarted()
Deprecated.useIKickEventListener
insteadvoid
processingStopped()
Deprecated.useIKickEventListener
insteadvoid
promptInputRequired(int runID)
Deprecated.useIKickEventListener
insteadvoid
read(Form form)
This method is called when activating an object which requires user input.void
treeChanged()
Deprecated.useIKickEventListener
instead
-
-
-
Method Detail
-
asyncMessage
void asyncMessage(AsyncMessage message)
This method is called if a new message is available.- Parameters:
message
- Message
-
read
void read(Form form)
This method is called when activating an object which requires user input. See also:READ
in the UC4 documentation.The request
SubmitForm
can be used to send the values to the Server and continue with the activation of the object.CancelForm
can be used to cancel the pending form. This also cancels the action of the object.- Parameters:
form
-Form
form
-
treeChanged
@Deprecated void treeChanged()
Deprecated.useIKickEventListener
insteadThis method is called if the tree structure in UC4 has changed.
-
activityListChanged
@Deprecated void activityListChanged()
Deprecated.useIKickEventListener
insteadThis method is called if the activity list changed.
-
highestCallOperatorChanged
@Deprecated void highestCallOperatorChanged()
Deprecated.useIKickEventListener
insteadThis method is called if a notification was added or removed for the current user.
-
processingStopped
@Deprecated void processingStopped()
Deprecated.useIKickEventListener
insteadThis method is called after the client state has changed to stop.
-
processingStarted
@Deprecated void processingStarted()
Deprecated.useIKickEventListener
insteadThis method is called after the client state has changed to active.
-
activationMessages
void activationMessages(int runNumner, UC4ObjectName task, TranslatedMessage[] messages)
This method is called if there is an activation protocol for a task.- Parameters:
runNumner
- RUN# of the tasktask
- Name of the taskmessages
- Array containing the messages
-
promptInputRequired
@Deprecated void promptInputRequired(int runID)
Deprecated.useIKickEventListener
insteadThis method is called if prompt values are required in order to a execute an object.- Parameters:
runID
- Run ID of the Object.
-
handleIOException
void handleIOException(java.io.IOException e)
This method is called if there was an I/O-error.- Parameters:
e
- Exception describing the error
-
-