org.pentaho.di.job.entries.msgboxinfo
Class JobEntryMsgBoxInfo

java.lang.Object
  org.pentaho.di.job.entry.JobEntryBase
      org.pentaho.di.job.entries.msgboxinfo.JobEntryMsgBoxInfo

All Implemented Interfaces:

Cloneable, CheckResultSourceInterface, LoggingObjectInterface, VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntryMsgBoxInfo
extends JobEntryBase
implements Cloneable, JobEntryInterface

Job entry type to display a message box.

Since:

12-02-2007

Author:

Samatar

Constructor Summary

JobEntryMsgBoxInfo()

JobEntryMsgBoxInfo(String n, String scr)

Method Summary

void	check(List<CheckResultInterface> remarks, JobMeta jobMeta) Support for overrides not having to put in a check method
Object	clone()
boolean	evaluate(Result result) Display the Message Box.
boolean	evaluates() check whether or not this job entry evaluates.
Result	execute(Result prev_result, int nr) Execute this job entry and return the result.
String	getBodyMessage()
String	getRealBodyMessage()
String	getRealTitleMessage()
String	getTitleMessage()
String	getXML()
boolean	isUnconditional()
void	loadRep(Repository rep, ObjectId id_jobentry, List<DatabaseMeta> databases, List<SlaveServer> slaveServers)
void	loadXML(Node entrynode, List<DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep)
boolean	resetErrorsBeforeExecution()
void	saveRep(Repository rep, ObjectId id_job)
void	setBodyMessage(String s)
void	setTitleMessage(String s)

Methods inherited from class org.pentaho.di.job.entry.JobEntryBase

clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getFilename, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentVariableSpace, getPluginId, getRealFilename, getRegistrationDate, getRepository, getRepositoryDirectory, getResourceDependencies, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, hasChanged, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isFTP, isHTTP, isJob, isMail, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, listVariables, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, parseRepositoryObjects, setChanged, setChanged, setContainerObjectId, setDescription, setID, setLogLevel, setName, setObjectId, setParentJob, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface

clear, exportResources, getDescription, getDialogClassName, getFilename, getLogChannel, getName, getObjectId, getParentJob, getPluginId, getRealFilename, getResourceDependencies, getSQLStatements, getSQLStatements, getTypeId, getUsedDatabaseConnections, hasChanged, hasRepositoryReferences, isDummy, isEvaluation, isJob, isMail, isShell, isSpecial, isStart, isTransformation, lookupRepositoryReferences, setChanged, setChanged, setDescription, setName, setObjectId, setParentJob, setPluginId, setRepository

Constructor Detail

JobEntryMsgBoxInfo

public JobEntryMsgBoxInfo(String n,
                          String scr)

JobEntryMsgBoxInfo

public JobEntryMsgBoxInfo()

Method Detail

clone

public Object clone()

Specified by:

clone in interface JobEntryInterface

Overrides:

clone in class JobEntryBase

getXML

public String getXML()

Specified by:

getXML in interface JobEntryInterface

Overrides:

getXML in class JobEntryBase

loadXML

public void loadXML(Node entrynode,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep)
             throws KettleXMLException

Specified by:

loadXML in interface JobEntryInterface

Throws:

KettleXMLException

loadRep

public void loadRep(Repository rep,
                    ObjectId id_jobentry,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws KettleException

Specified by:

loadRep in interface JobEntryInterface

Overrides:

loadRep in class JobEntryBase

Throws:

KettleException

saveRep

public void saveRep(Repository rep,
                    ObjectId id_job)
             throws KettleException

Specified by:

saveRep in interface JobEntryInterface

Overrides:

saveRep in class JobEntryBase

Throws:

KettleException

evaluate

public boolean evaluate(Result result)

Display the Message Box.

execute

public Result execute(Result prev_result,
                      int nr)

Execute this job entry and return the result. In this case it means, just set the result boolean in the Result class.

Specified by:

execute in interface JobEntryInterface

Parameters:

prev_result - The result of the previous execution

Returns:

The Result of the execution.

resetErrorsBeforeExecution

public boolean resetErrorsBeforeExecution()

Specified by:

resetErrorsBeforeExecution in interface JobEntryInterface

Overrides:

resetErrorsBeforeExecution in class JobEntryBase

Returns:

true if a reset of the number of errors is required before execution.

evaluates

public boolean evaluates()

Description copied from class: JobEntryBase

check whether or not this job entry evaluates.

Specified by:

evaluates in interface JobEntryInterface

Overrides:

evaluates in class JobEntryBase

Returns:

true if the job entry evaluates

isUnconditional

public boolean isUnconditional()

Specified by:

isUnconditional in interface JobEntryInterface

Overrides:

isUnconditional in class JobEntryBase

getRealTitleMessage

public String getRealTitleMessage()

getRealBodyMessage

public String getRealBodyMessage()

getTitleMessage

public String getTitleMessage()

getBodyMessage

public String getBodyMessage()

setBodyMessage

public void setBodyMessage(String s)

setTitleMessage

public void setTitleMessage(String s)

check

public void check(List<CheckResultInterface> remarks,
                  JobMeta jobMeta)

Description copied from class: JobEntryBase

Support for overrides not having to put in a check method

Specified by:

check in interface JobEntryInterface

Overrides:

check in class JobEntryBase

Parameters:

remarks - CheckResults from checking the job entry

jobMeta - JobMeta information letting threading back to the JobMeta possible