Package com.mindtree.techworks.insight.reporting.jobs.message

JobMessages provide reporting data to a Job.

See:
Description

Interface Summary

JobMessage

A JobMessage is the data passed on to a Job for executing its task.

Class Summary

DefaultJobMessage

A simple implementation of JobMessage.

Package com.mindtree.techworks.insight.reporting.jobs.message Description

JobMessages provide reporting data to a Job.

When a Verifier needs to call a Job for execution of a task, it would use a specialization of JobMessage to send the required data to the Job.

A Job can choose to accept only specific types of JobMessages at their discretion. This should be returned by the getSupportedMessageTypes() method. The values returned by this method should be compatible the same as returned by the getJobMessageType() methods of the supported JobMessage class. For a supported JobMessage, the Jobs isMessageTypeSupported(String) should also return true when the message type of that JobMessage is passed to the Job.

However, to avoid the scenario where a Verifier wishing to call a Job does not understand or is unable to create any JobMessage type understood by the Job, all Jobs are required to support at least the DefaultJobMessage.

Apart from the data specific to the JobMessage, an object of the class also carries some metadata about the operation that led to its creation and also the execution of the Job. This data includes:

1. Mode Insight was running in - Interactive or Daemon.
2. The operation that created the message - Filter, Search, etc.
3. The criteria used in the operation.

JobMessage Design

The UML diagram below gives the High Level design of JobMessages.


Click on any of the classes above to see a detailed documentation of the class.

Since:

Insight 1.5

Version:

$Revision: 28 $ $Date: 2007-12-16 05:06:46 -0700 (Sun, 16 Dec 2007) $

Author:

Bindul Bhowmik

See Also:

com.mindtree.techworks.insight.reporting.verifiers, com.mindtree.techworks.insight.reporting.jobs