JobEntryBase (PDI Engine 9.1.0.0-317 API)

java.lang.Object
- org.pentaho.di.job.entry.JobEntryBase

All Implemented Interfaces:

Cloneable, AttributesInterface, CheckResultSourceInterface, ExtensionDataInterface, LoggingObjectInterface, VariableSpace, ResourceHolderInterface

Direct Known Subclasses:

JobEntryCheckFilesLocked, JobEntryColumnsExist, JobEntryConnectedToRepository, JobEntryCopyFiles, JobEntryCopyMoveResultFilenames, JobEntryCreateFile, JobEntryCreateFolder, JobEntryDelay, JobEntryDeleteFile, JobEntryDeleteFiles, JobEntryDeleteFolders, JobEntryDeleteResultFilenames, JobEntryDosToUnix, JobEntryEmpty, JobEntryEval, JobEntryEvalFilesMetrics, JobEntryEvalTableContent, JobEntryExportRepository, JobEntryFileCompare, JobEntryFileExists, JobEntryFilesExist, JobEntryFolderIsEmpty, JobEntryFoldersCompare, JobEntryFTP, JobEntryFTPDelete, JobEntryFTPPUT, JobEntryFTPSGet, JobEntryFTPSPUT, JobEntryGetPOP, JobEntryHTTP, JobEntryJob, JobEntryMail, JobEntryMailValidator, JobEntryMoveFiles, JobEntryMsgBoxInfo, JobEntryMssqlBulkLoad, JobEntryMysqlBulkFile, JobEntryMysqlBulkLoad, JobEntryPGPDecryptFiles, JobEntryPGPEncryptFiles, JobEntryPGPVerify, JobEntryPing, JobEntrySendNagiosPassiveCheck, JobEntrySetVariables, JobEntrySFTP, JobEntrySFTPPUT, JobEntryShell, JobEntrySimpleEval, JobEntrySNMPTrap, JobEntrySpecial, JobEntrySQL, JobEntrySuccess, JobEntrySyslog, JobEntryTableExists, JobEntryTalendJobExec, JobEntryTelnet, JobEntryTrans, JobEntryTruncateTables, JobEntryUnZip, JobEntryWaitForFile, JobEntryWaitForSQL, JobEntryWebServiceAvailable, JobEntryWriteToFile, JobEntryWriteToLog, JobEntryZipFile
```
public class JobEntryBase
extends Object
implements Cloneable, VariableSpace, CheckResultSourceInterface, ResourceHolderInterface, LoggingObjectInterface, AttributesInterface, ExtensionDataInterface
```
Base class for the different types of job-entries. Job entries can extend this base class to get access to common member variables and default method behavior. However, JobEntryBase does not implement JobEntryInterface (although it implements most of the same methods), so individual job entry classes must implement JobEntryInterface and specifically the execute() method.

Author:

Matt Created on 18-jun-04

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Map<String,String>>`	`attributesMap`
`protected String`	`containerObjectId` The container object id
`protected Map<String,String>`	`entryStepSetVariablesMap` The map for setVariablesStep bindings for the job entry
`protected Map<String,Object>`	`extensionDataMap`
`protected LogChannelInterface`	`log` The log channel interface object, used for logging
`protected org.pentaho.metastore.api.IMetaStore`	`metaStore`
`protected Job`	`parentJob` The parent job
`protected JobMeta`	`parentJobMeta`
`protected Repository`	`rep` The repository
`protected VariableSpace`	`variables` The variable bindings for the job entry

Constructor Summary

Constructors
Constructor and Description
`JobEntryBase()` Instantiates a new job entry base object.
`JobEntryBase(String name, String description)` Instantiates a new job entry base object with the given name and description.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected String`	`addDatetimeToFilename(String filename, boolean addDate, String datePattern, boolean addTime, String timePattern, boolean specifyFormat, String datetimeFormat)` Appends the date, time and/or datetime to the given filename (before the extension if it exists), using the provided patterns.
`void`	`check(List<CheckResultInterface> remarks, JobMeta jobMeta)` Deprecated. use `check(List, JobMeta, VariableSpace, Repository, IMetaStore)`
`void`	`check(List<CheckResultInterface> remarks, JobMeta jobMeta, VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)` Allows JobEntry objects to check themselves for consistency
`void`	`clear()` Clears all variable values
`Object`	`clone()` This method is called when a job entry is duplicated in Spoon.
`void`	`copyVariablesFrom(VariableSpace space)` Copies variables from a given variable space to this job entry
`String`	`environmentSubstitute(String aString)` Substitutes any variable values into the given string, and returns the resolved string
`String[]`	`environmentSubstitute(String[] aString)` Substitutes any variable values into each of the given strings, and returns an array containing the resolved string(s)
`boolean`	`equals(Object obj)` Checks if the JobEntry object is equal to the specified object
`boolean`	`evaluates()` This method must return true if the job entry supports the true/false outgoing hops.
`String`	`exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface namingInterface, Repository repository)` Deprecated. use `exportResources(VariableSpace, Map, ResourceNamingInterface, Repository, IMetaStore)`
`String`	`exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface namingInterface, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)` Exports the object to a flat-file system, adding content with filename keys to a set of definitions.
`String`	`fieldSubstitute(String aString, RowMetaInterface rowMeta, Object[] rowData)`
`String`	`getAttribute(String groupName, String key)`
`Map<String,String>`	`getAttributes(String groupName)`
`Map<String,Map<String,String>>`	`getAttributesMap()`
`boolean`	`getBooleanValueOfVariable(String variableName, boolean defaultValue)` Returns a boolean representation of the specified variable after performing any necessary substitution.
`String`	`getContainerObjectId()` Gets the container object id
`String`	`getDescription()` Gets the description of the job entry
`String`	`getDialogClassName()` Deprecated. As of release 8.1, use annotated-based dialog instead `PluginDialog`
`String`	`getEntryStepSetVariable(String variableName)` Gets the value of the specified EntryStepSetVariable
`protected Map<String,String>`	`getEntryStepSetVariablesMap()` Gets a Map of variables set in EntryStepSetVariables
`Map<String,Object>`	`getExtensionDataMap()`
`String`	`getFilename()` Gets the filename of the job entry.
`String`	`getHolderType()` Returns the holder type for the job entry
`LogChannelInterface`	`getLogChannel()` Gets the log channel.
`String`	`getLogChannelId()` Gets the logging channel id
`LogLevel`	`getLogLevel()` Gets the logging level for the job entry
`org.pentaho.metastore.api.IMetaStore`	`getMetaStore()`
`String`	`getName()` Gets the name of the job entry
`String`	`getObjectCopy()` Gets a string identifying a copy in a series of steps
`ObjectId`	`getObjectId()` Gets the object id
`String`	`getObjectName()` Gets the object name
`ObjectRevision`	`getObjectRevision()` Gets the revision of the object with respect to a repository
`LoggingObjectType`	`getObjectType()` Gets the logging object type
`LoggingObjectInterface`	`getParent()` Gets the logging object interface's parent
`Job`	`getParentJob()` Gets the parent job.
`JobMeta`	`getParentJobMeta()`
`VariableSpace`	`getParentVariableSpace()` Gets the parent variable space
`String`	`getPluginId()` Gets the plugin id.
`String`	`getRealFilename()` Gets the real filename of the job entry, by substituting any environment variables present in the filename.
`String[]`	`getReferencedObjectDescriptions()`
`Date`	`getRegistrationDate()` Returns the registration date for the job entry.
`Repository`	`getRepository()` Gets the repository for the job entry.
`RepositoryDirectory`	`getRepositoryDirectory()` Gets the directory of the job entry in the repository.
`List<ResourceReference>`	`getResourceDependencies(JobMeta jobMeta)` Gets a list of all the resource dependencies that the step is depending on.
`List<SQLStatement>`	`getSQLStatements(Repository repository)` Deprecated. use `getSQLStatements(Repository, IMetaStore, VariableSpace)`
`List<SQLStatement>`	`getSQLStatements(Repository repository, org.pentaho.metastore.api.IMetaStore metaStore, VariableSpace space)` Gets the SQL statements needed by this job entry to execute successfully, given a set of variables.
`List<SQLStatement>`	`getSQLStatements(Repository repository, VariableSpace space)` Deprecated. use `getSQLStatements(Repository, IMetaStore, VariableSpace)`
`String`	`getTypeDesc()` Gets the plug-in type description
`String`	`getTypeId()` Deprecated. use `getPluginId()`
`DatabaseMeta[]`	`getUsedDatabaseConnections()` Gets all the database connections that are used by the job entry.
`String`	`getVariable(String variableName)` Gets the value of the specified variable, or returns a default value if no such variable exists
`String`	`getVariable(String variableName, String defaultValue)` Gets the value of the specified variable, or returns a default value if no such variable exists
`protected VariableSpace`	`getVariables()` Gets the variable bindings for the job entry.
`String`	`getXML()` This method is called by PDI whenever a job entry needs to serialize its settings to XML.
`boolean`	`hasChanged()` Checks whether the job entry has changed
`int`	`hashCode()`
`boolean`	`hasRepositoryReferences()` Checks whether the job entry has repository references.
`void`	`initializeVariablesFrom(VariableSpace parent)` Sets the values of the job entry's variables to the values from the parent variables
`void`	`injectVariables(Map<String,String> prop)` Injects variables using the given Map.
`boolean`	`isBasic()` Checks if the logging level is basic.
`boolean`	`isDebug()` Checks if the logging level is debug.
`boolean`	`isDetailed()` Checks if the logging level is detailed.
`boolean`	`isDummy()` Checks if the job entry is a dummy entry
`boolean`	`isEvaluation()` Checks if the job entry is an evaluation.
`boolean`	`isForcingSeparateLogging()`
`boolean`	`isFTP()` Checks if this job entry performs an FTP operation
`boolean`	`isGatheringMetrics()`
`boolean`	`isHTTP()` Checks if this job entry performs an HTTP operation
`boolean`	`isJob()` Checks if the job entry executes a job
`boolean`	`isMail()` Checks if the job entry sends email
`boolean[]`	`isReferencedObjectEnabled()`
`boolean`	`isRowlevel()` Checks if the logging level is rowlevel.
`boolean`	`isSFTP()` Checks if this job entry performs an SFTP operation
`boolean`	`isShell()` Checks if the job entry executes a shell program
`boolean`	`isSpecial()` Checks if the job entry is of a special type (Start, Dummy, etc.)
`boolean`	`isStart()` Checks if the job entry has started
`boolean`	`isTransformation()` Checks if this job entry executes a transformation
`boolean`	`isUnconditional()` This method must return true if the job entry supports the unconditional outgoing hop.
`String[]`	`listVariables()` Gets a list of variable names for the job entry
`Object`	`loadReferencedObject(int index, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, VariableSpace space)` Load the referenced object
`Object`	`loadReferencedObject(int index, Repository rep, VariableSpace space)` Deprecated. use `loadReferencedObject(int, Repository, IMetaStore, VariableSpace)`
`void`	`loadRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, ObjectId id_jobentry, List<DatabaseMeta> databases, List<SlaveServer> slaveServers)`
`void`	`loadRep(Repository rep, ObjectId id_jobentry, List<DatabaseMeta> databases, List<SlaveServer> slaveServers)` Deprecated. use `loadRep(Repository, IMetaStore, ObjectId, List, List)`
`void`	`loadXML(Node entrynode, List<DatabaseMeta> databases, List<SlaveServer> slaveServers)` This method is called by PDI whenever a job entry needs to read its settings from XML.
`void`	`loadXML(Node entrynode, List<DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository repository)` Deprecated. use `loadXML(Node, List, List, Repository, IMetaStore)`
`void`	`loadXML(Node entrynode, List<DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore)`
`void`	`logBasic(String message)` Logs the specified string at the basic level.
`void`	`logBasic(String message, Object... arguments)` Logs the specified string and arguments at the basic level.
`void`	`logDebug(String message)` Logs the specified string at the debug level.
`void`	`logDebug(String message, Object... arguments)` Logs the specified string and arguments at the debug level.
`void`	`logDetailed(String message)` Logs the specified string at the detailed level.
`void`	`logDetailed(String message, Object... arguments)` Logs the specified string and arguments at the detailed level.
`void`	`logError(String message)` Logs the specified string at the error level.
`void`	`logError(String message, Object... arguments)` Logs the specified string and arguments at the error level.
`void`	`logError(String message, Throwable e)` Logs the specified string and Throwable object at the error level.
`void`	`logMinimal(String message)` Logs the specified string at the minimal level.
`void`	`logMinimal(String message, Object... arguments)` Logs the specified string and arguments at the minimal level.
`void`	`logRowlevel(String message)` Logs the specified string at the row level.
`void`	`logRowlevel(String message, Object... arguments)` Logs the specified string and arguments at the row level.
`void`	`lookupRepositoryReferences(Repository repository)` Looks up the references after import
`void`	`parseRepositoryObjects(Repository rep)` Parses the repository objects.
`boolean`	`resetErrorsBeforeExecution()` Checks whether a reset of the number of errors is required before execution.
`void`	`saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, ObjectId id_job)`
`void`	`saveRep(Repository rep, ObjectId id_job)` Deprecated. use `saveRep(Repository, IMetaStore, ObjectId)`
`void`	`setAttribute(String groupName, String key, String value)`
`void`	`setAttributes(String groupName, Map<String,String> attributes)`
`void`	`setAttributesMap(Map<String,Map<String,String>> attributesMap)`
`void`	`setChanged()` Sets that the job entry has changed (i.e.
`void`	`setChanged(boolean ch)` Sets whether the job entry has changed
`void`	`setContainerObjectId(String containerObjectId)` Sets the container object id
`void`	`setDescription(String Description)` Sets the description for the job entry.
`void`	`setEntryStepSetVariable(String variableName, String variableValue)` Sets the value of the specified EntryStepSetVariable
`void`	`setForcingSeparateLogging(boolean forcingSeparateLogging)`
`void`	`setGatheringMetrics(boolean gatheringMetrics)`
`void`	`setID(long id)` Sets the id for the job entry
`void`	`setLogLevel(LogLevel logLevel)` Sets the logging level for the job entry
`void`	`setMetaStore(org.pentaho.metastore.api.IMetaStore metaStore)`
`void`	`setName(String name)` Sets the name of the job entry
`void`	`setObjectId(ObjectId id)` Sets the object id.
`void`	`setParentJob(Job parentJob)` Sets the parent job.
`void`	`setParentJobMeta(JobMeta parentJobMeta)` At save and run time, the system will attempt to set the jobMeta so that it can be accessed by the jobEntries if necessary.
`void`	`setParentVariableSpace(VariableSpace parent)` Sets the parent variable space
`void`	`setPluginId(String configId)` Sets the plugin id.
`void`	`setRepository(Repository repository)` Sets the repository for the job entry.
`void`	`setTypeId(String typeId)` Deprecated. use `setPluginId(String)`
`void`	`setVariable(String variableName, String variableValue)` Sets the value of the specified variable to the specified value
`void`	`shareVariablesWith(VariableSpace space)` Shares a variable space from another variable space.
`String`	`toString()` Returns a string representation of the object.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pentaho.di.core.variables.VariableSpace
environmentSubstitute

- Field Detail
  - variables
```
protected VariableSpace variables
```
    The variable bindings for the job entry
  - entryStepSetVariablesMap
```
protected Map<String,String> entryStepSetVariablesMap
```
    The map for setVariablesStep bindings for the job entry
  - rep
```
protected Repository rep
```
    The repository
  - parentJob
```
protected Job parentJob
```
    The parent job
  - log
```
protected LogChannelInterface log
```
    The log channel interface object, used for logging
  - containerObjectId
```
protected String containerObjectId
```
    The container object id
  - metaStore
```
protected org.pentaho.metastore.api.IMetaStore metaStore
```
  - attributesMap
```
protected Map<String,Map<String,String>> attributesMap
```
  - extensionDataMap
```
protected Map<String,Object> extensionDataMap
```
  - parentJobMeta
```
protected JobMeta parentJobMeta
```
- Constructor Detail
  - JobEntryBase
```
public JobEntryBase()
```
    Instantiates a new job entry base object.
  - JobEntryBase
```
public JobEntryBase(String name,
                    String description)
```
    Instantiates a new job entry base object with the given name and description.
    
    Parameters:
    
    name - the name of the job entry
    
    description - the description of the job entry
- Method Detail
  - equals
```
public boolean equals(Object obj)
```
    Checks if the JobEntry object is equal to the specified object
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if the two objects are equal, false otherwise
    
    See Also:
    
    Object.equals(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clear
```
public void clear()
```
    Clears all variable values
  - setObjectId
```
public void setObjectId(ObjectId id)
```
    Sets the object id.
    
    Parameters:
    
    id - the new object id
  - setID
```
public void setID(long id)
```
    Sets the id for the job entry
    
    Parameters:
    
    id - the new id
  - getObjectId
```
public ObjectId getObjectId()
```
    Gets the object id
    
    Specified by:
    
    getObjectId in interface CheckResultSourceInterface
    
    Specified by:
    
    getObjectId in interface LoggingObjectInterface
    
    Specified by:
    
    getObjectId in interface ResourceHolderInterface
    
    Returns:
    
    the object id
    
    See Also:
    
    CheckResultSourceInterface.getObjectId()
  - getTypeDesc
```
public String getTypeDesc()
```
    Gets the plug-in type description
    
    Returns:
    
    the plug-in type description
  - setName
```
public void setName(String name)
```
    Sets the name of the job entry
    
    Parameters:
    
    name - the new name
  - getName
```
public String getName()
```
    Gets the name of the job entry
    
    Specified by:
    
    getName in interface CheckResultSourceInterface
    
    Specified by:
    
    getName in interface ResourceHolderInterface
    
    Returns:
    
    the name of the job entry
    
    See Also:
    
    CheckResultSourceInterface.getName()
  - setDescription
```
public void setDescription(String Description)
```
    Sets the description for the job entry.
    
    Parameters:
    
    Description - the new description
  - getDescription
```
public String getDescription()
```
    Gets the description of the job entry
    
    Specified by:
    
    getDescription in interface CheckResultSourceInterface
    
    Specified by:
    
    getDescription in interface ResourceHolderInterface
    
    Returns:
    
    the description of the job entry
    
    See Also:
    
    CheckResultSourceInterface.getDescription()
  - setChanged
```
public void setChanged()
```
    Sets that the job entry has changed (i.e. a call to setChanged(true))
    
    See Also:
    
    setChanged(boolean)
  - setChanged
```
public void setChanged(boolean ch)
```
    Sets whether the job entry has changed
    
    Parameters:
    
    ch - true if the job entry has changed, false otherwise
  - hasChanged
```
public boolean hasChanged()
```
    Checks whether the job entry has changed
    
    Returns:
    
    true if the job entry has changed, false otherwise
  - isStart
```
public boolean isStart()
```
    Checks if the job entry has started
    
    Returns:
    
    true if the job entry has started, false otherwise
  - isDummy
```
public boolean isDummy()
```
    Checks if the job entry is a dummy entry
    
    Returns:
    
    true if the job entry is a dummy entry, false otherwise
  - isEvaluation
```
public boolean isEvaluation()
```
    Checks if the job entry is an evaluation.
    
    Returns:
    
    true if the job entry is an evaluation, false otherwise
  - isJob
```
public boolean isJob()
```
    Checks if the job entry executes a job
    
    Returns:
    
    true if the job entry executes a job, false otherwise
  - isMail
```
public boolean isMail()
```
    Checks if the job entry sends email
    
    Returns:
    
    true if the job entry sends email, false otherwise
  - isShell
```
public boolean isShell()
```
    Checks if the job entry executes a shell program
    
    Returns:
    
    true if the job entry executes a shell program, false otherwise
  - isSpecial
```
public boolean isSpecial()
```
    Checks if the job entry is of a special type (Start, Dummy, etc.)
    
    Returns:
    
    true if the job entry is of a special type, false otherwise
  - isTransformation
```
public boolean isTransformation()
```
    Checks if this job entry executes a transformation
    
    Returns:
    
    true if this job entry executes a transformation, false otherwise
  - isFTP
```
public boolean isFTP()
```
    Checks if this job entry performs an FTP operation
    
    Returns:
    
    true if this job entry performs an FTP operation, false otherwise
  - isSFTP
```
public boolean isSFTP()
```
    Checks if this job entry performs an SFTP operation
    
    Returns:
    
    true if this job entry performs an SFTP operation, false otherwise
  - isHTTP
```
public boolean isHTTP()
```
    Checks if this job entry performs an HTTP operation
    
    Returns:
    
    true if this job entry performs an HTTP operation, false otherwise
  - getXML
```
public String getXML()
```
    This method is called by PDI whenever a job entry needs to serialize its settings to XML. It is called when saving a job in Spoon. The method returns an XML string, containing the serialized settings. The string contains a series of XML tags, typically one tag per setting. The helper class org.pentaho.di.core.xml.XMLHandler is typically used to construct the XML string.
    
    Returns:
    
    the xml representation of the job entry
  - loadXML
```
public void loadXML(Node entrynode,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws KettleXMLException
```
    This method is called by PDI whenever a job entry needs to read its settings from XML. The XML node containing the job entry's settings is passed in as an argument. Again, the helper class org.pentaho.di.core.xml.XMLHandler is typically used to conveniently read the settings from the XML node.
    
    Parameters:
    
    entrynode - the top-level XML node
    
    databases - the list of databases
    
    slaveServers - the list of slave servers
    
    Throws:
    
    KettleXMLException - if any errors occur during the loading of the XML
  - loadXML
```
@Deprecated
public void loadXML(Node entrynode,
                                List<DatabaseMeta> databases,
                                List<SlaveServer> slaveServers,
                                Repository repository)
                         throws KettleXMLException
```
    Deprecated. use loadXML(Node, List, List, Repository, IMetaStore)
    
    Parameters:
    
    entrynode -
    
    databases -
    
    slaveServers -
    
    repository -
    
    Throws:
    
    KettleXMLException
  - loadXML
```
public void loadXML(Node entrynode,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws KettleXMLException
```
    Throws:
    
    KettleXMLException
  - parseRepositoryObjects
```
public void parseRepositoryObjects(Repository rep)
                            throws KettleException
```
    Parses the repository objects. For JobEntryBase, this is a stub (empty) method
    
    Parameters:
    
    rep - the repository
    
    Throws:
    
    KettleException - if any errors occur during parsing
  - loadRep
```
@Deprecated
public void loadRep(Repository rep,
                                ObjectId id_jobentry,
                                List<DatabaseMeta> databases,
                                List<SlaveServer> slaveServers)
                         throws KettleException
```
    Deprecated. use loadRep(Repository, IMetaStore, ObjectId, List, List)
    
    This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. For JobEntryBase, this method performs no operations.
    
    Parameters:
    
    rep - the repository object
    
    id_jobentry - the id of the job entry
    
    databases - the list of databases
    
    slaveServers - the list of slave servers
    
    Throws:
    
    KettleException - if any errors occur during the load
  - loadRep
```
public void loadRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    ObjectId id_jobentry,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws KettleException
```
    Throws:
    
    KettleException
  - saveRep
```
@Deprecated
public void saveRep(Repository rep,
                                ObjectId id_job)
                         throws KettleException
```
    Deprecated. use saveRep(Repository, IMetaStore, ObjectId)
    
    This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. For JobEntryBase, this method performs no operations.
    
    Parameters:
    
    rep - the repository object
    
    id_job - the id_job
    
    Throws:
    
    KettleException - if any errors occur during the save
  - saveRep
```
public void saveRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    ObjectId id_job)
             throws KettleException
```
    Parameters:
    
    rep -
    
    metaStore -
    
    id_job -
    
    Throws:
    
    KettleException
  - clone
```
public Object clone()
```
    This method is called when a job entry is duplicated in Spoon. It needs to return a deep copy of this job entry object. It is essential that the implementing class creates proper deep copies if the job entry configuration is stored in modifiable objects, such as lists or custom helper objects.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a clone of the object
  - toString
```
public String toString()
```
    Returns a string representation of the object. For JobEntryBase, this method returns the name
    
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
  - resetErrorsBeforeExecution
```
public boolean resetErrorsBeforeExecution()
```
    Checks whether a reset of the number of errors is required before execution.
    
    Returns:
    
    true if a reset of the number of errors is required before execution, false otherwise
  - evaluates
```
public boolean evaluates()
```
    This method must return true if the job entry supports the true/false outgoing hops. For JobEntryBase, this method always returns false
    
    Returns:
    
    false
  - isUnconditional
```
public boolean isUnconditional()
```
    This method must return true if the job entry supports the unconditional outgoing hop. For JobEntryBase, this method always returns true
    
    Returns:
    
    true
  - getSQLStatements
```
@Deprecated
public List<SQLStatement> getSQLStatements(Repository repository)
                                                throws KettleException
```
    Deprecated. use getSQLStatements(Repository, IMetaStore, VariableSpace)
    
    Gets the SQL statements needed by this job entry to execute successfully.
    
    Parameters:
    
    repository - the repository
    
    Returns:
    
    a list of SQL statements
    
    Throws:
    
    KettleException - if any errors occur during the generation of SQL statements
  - getSQLStatements
```
@Deprecated
public List<SQLStatement> getSQLStatements(Repository repository,
                                                       VariableSpace space)
                                                throws KettleException
```
    Deprecated. use getSQLStatements(Repository, IMetaStore, VariableSpace)
    
    Gets the SQL statements needed by this job entry to execute successfully, given a set of variables. For JobEntryBase, this method returns an empty list.
    
    Parameters:
    
    repository - the repository object
    
    space - a variable space object containing variable bindings
    
    Returns:
    
    an empty list
    
    Throws:
    
    KettleException - if any errors occur during the generation of SQL statements
  - getSQLStatements
```
public List<SQLStatement> getSQLStatements(Repository repository,
                                           org.pentaho.metastore.api.IMetaStore metaStore,
                                           VariableSpace space)
                                    throws KettleException
```
    Gets the SQL statements needed by this job entry to execute successfully, given a set of variables. For JobEntryBase, this method returns an empty list.
    
    Parameters:
    
    repository - the repository object
    
    space - a variable space object containing variable bindings
    
    Returns:
    
    an empty list
    
    Throws:
    
    KettleException - if any errors occur during the generation of SQL statements
  - getFilename
```
public String getFilename()
```
    Gets the filename of the job entry. For JobEntryBase, this method always returns null
    
    Specified by:
    
    getFilename in interface LoggingObjectInterface
    
    Returns:
    
    null
    
    See Also:
    
    LoggingObjectInterface.getFilename()
  - getRealFilename
```
public String getRealFilename()
```
    Gets the real filename of the job entry, by substituting any environment variables present in the filename. For JobEntryBase, this method always returns null
    
    Returns:
    
    null
  - getUsedDatabaseConnections
```
public DatabaseMeta[] getUsedDatabaseConnections()
```
    Gets all the database connections that are used by the job entry. For JobEntryBase, this method returns an empty (non-null) array
    
    Returns:
    
    an empty (non-null) array
  - copyVariablesFrom
```
public void copyVariablesFrom(VariableSpace space)
```
    Copies variables from a given variable space to this job entry
    
    Specified by:
    
    copyVariablesFrom in interface VariableSpace
    
    See Also:
    
    VariableSpace.copyVariablesFrom(org.pentaho.di.core.variables.VariableSpace)
  - environmentSubstitute
```
public String environmentSubstitute(String aString)
```
    Substitutes any variable values into the given string, and returns the resolved string
    
    Specified by:
    
    environmentSubstitute in interface VariableSpace
    
    Returns:
    
    the string with any environment variables resolved and substituted
    
    See Also:
    
    VariableSpace.environmentSubstitute(java.lang.String)
  - environmentSubstitute
```
public String[] environmentSubstitute(String[] aString)
```
    Substitutes any variable values into each of the given strings, and returns an array containing the resolved string(s)
    
    Specified by:
    
    environmentSubstitute in interface VariableSpace
    
    See Also:
    
    VariableSpace.environmentSubstitute(java.lang.String[])
  - fieldSubstitute
```
public String fieldSubstitute(String aString,
                              RowMetaInterface rowMeta,
                              Object[] rowData)
                       throws KettleValueException
```
    Specified by:
    
    fieldSubstitute in interface VariableSpace
    
    Throws:
    
    KettleValueException
  - getParentVariableSpace
```
public VariableSpace getParentVariableSpace()
```
    Gets the parent variable space
    
    Specified by:
    
    getParentVariableSpace in interface VariableSpace
    
    Returns:
    
    the parent variable space
    
    See Also:
    
    VariableSpace.getParentVariableSpace()
  - setParentVariableSpace
```
public void setParentVariableSpace(VariableSpace parent)
```
    Sets the parent variable space
    
    Specified by:
    
    setParentVariableSpace in interface VariableSpace
    
    See Also:
    
    VariableSpace.setParentVariableSpace( org.pentaho.di.core.variables.VariableSpace)
  - getVariable
```
public String getVariable(String variableName,
                          String defaultValue)
```
    Gets the value of the specified variable, or returns a default value if no such variable exists
    
    Specified by:
    
    getVariable in interface VariableSpace
    
    Returns:
    
    the value of the specified variable, or returns a default value if no such variable exists
    
    See Also:
    
    VariableSpace.getVariable(java.lang.String, java.lang.String)
  - getVariable
```
public String getVariable(String variableName)
```
    Gets the value of the specified variable, or returns a default value if no such variable exists
    
    Specified by:
    
    getVariable in interface VariableSpace
    
    Returns:
    
    the value of the specified variable, or returns a default value if no such variable exists
    
    See Also:
    
    VariableSpace.getVariable(java.lang.String)
  - getBooleanValueOfVariable
```
public boolean getBooleanValueOfVariable(String variableName,
                                         boolean defaultValue)
```
    Returns a boolean representation of the specified variable after performing any necessary substitution. Truth values include case-insensitive versions of "Y", "YES", "TRUE" or "1".
    
    Specified by:
    
    getBooleanValueOfVariable in interface VariableSpace
    
    Parameters:
    
    variableName - the name of the variable to interrogate
    
    Returns:
    
    a boolean representation of the specified variable after performing any necessary substitution
    
    See Also:
    
    VariableSpace.getBooleanValueOfVariable(java.lang.String, boolean)
  - initializeVariablesFrom
```
public void initializeVariablesFrom(VariableSpace parent)
```
    Sets the values of the job entry's variables to the values from the parent variables
    
    Specified by:
    
    initializeVariablesFrom in interface VariableSpace
    
    See Also:
    
    VariableSpace.initializeVariablesFrom( org.pentaho.di.core.variables.VariableSpace)
  - listVariables
```
public String[] listVariables()
```
    Gets a list of variable names for the job entry
    
    Specified by:
    
    listVariables in interface VariableSpace
    
    Returns:
    
    a list of variable names
    
    See Also:
    
    VariableSpace.listVariables()
  - setVariable
```
public void setVariable(String variableName,
                        String variableValue)
```
    Sets the value of the specified variable to the specified value
    
    Specified by:
    
    setVariable in interface VariableSpace
    
    See Also:
    
    VariableSpace.setVariable(java.lang.String, java.lang.String)
  - shareVariablesWith
```
public void shareVariablesWith(VariableSpace space)
```
    Shares a variable space from another variable space. This means that the object should take over the space used as argument.
    
    Specified by:
    
    shareVariablesWith in interface VariableSpace
    
    See Also:
    
    VariableSpace.shareVariablesWith(org.pentaho.di.core.variables.VariableSpace)
  - injectVariables
```
public void injectVariables(Map<String,String> prop)
```
    Injects variables using the given Map. The behavior should be that the properties object will be stored and at the time the VariableSpace is initialized (or upon calling this method if the space is already initialized). After injecting the link of the properties object should be removed.
    
    Specified by:
    
    injectVariables in interface VariableSpace
    
    See Also:
    
    VariableSpace.injectVariables(java.util.Map)
  - check
```
@Deprecated
public void check(List<CheckResultInterface> remarks,
                              JobMeta jobMeta)
```
    Deprecated. use check(List, JobMeta, VariableSpace, Repository, IMetaStore)
    
    Support for overrides not having to put in a check method. For JobEntryBase, this method performs no operations.
    
    Parameters:
    
    remarks - CheckResults from checking the job entry
    
    jobMeta - JobMeta information letting threading back to the JobMeta possible
  - check
```
public void check(List<CheckResultInterface> remarks,
                  JobMeta jobMeta,
                  VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)
```
    Allows JobEntry objects to check themselves for consistency
    
    Parameters:
    
    remarks - List of CheckResult objects indicating consistency status
    
    jobMeta - the metadata object for the job entry
    
    space - the variable space to resolve string expressions with variables with
    
    repository - the repository to load Kettle objects from
    
    metaStore - the MetaStore to load common elements from
  - getResourceDependencies
```
public List<ResourceReference> getResourceDependencies(JobMeta jobMeta)
```
    Gets a list of all the resource dependencies that the step is depending on. In JobEntryBase, this method returns an empty resource dependency list.
    
    Returns:
    
    an empty list of ResourceReferences
    
    See Also:
    
    ResourceReference
  - exportResources
```
@Deprecated
public String exportResources(VariableSpace space,
                                          Map<String,ResourceDefinition> definitions,
                                          ResourceNamingInterface namingInterface,
                                          Repository repository)
                                   throws KettleException
```
    Deprecated. use exportResources(VariableSpace, Map, ResourceNamingInterface, Repository, IMetaStore)
    
    Exports the object to a flat-file system, adding content with filename keys to a set of definitions. For JobEntryBase, this method simply returns null
    
    Parameters:
    
    space - The variable space to resolve (environment) variables with.
    
    definitions - The map containing the filenames and content
    
    namingInterface - The resource naming interface allows the object to be named appropriately
    
    repository - The repository to load resources from
    
    Returns:
    
    The filename for this object. (also contained in the definitions map)
    
    Throws:
    
    KettleException - in case something goes wrong during the export
  - exportResources
```
public String exportResources(VariableSpace space,
                              Map<String,ResourceDefinition> definitions,
                              ResourceNamingInterface namingInterface,
                              Repository repository,
                              org.pentaho.metastore.api.IMetaStore metaStore)
                       throws KettleException
```
    Exports the object to a flat-file system, adding content with filename keys to a set of definitions. The supplied resource naming interface allows the object to name appropriately without worrying about those parts of the implementation specific details.
    
    Parameters:
    
    space - The variable space to resolve (environment) variables with.
    
    definitions - The map containing the filenames and content
    
    namingInterface - The resource naming interface allows the object to be named appropriately
    
    repository - The repository to load resources from
    
    metaStore - the metaStore to load external metadata from
    
    Returns:
    
    The filename for this object. (also contained in the definitions map)
    
    Throws:
    
    KettleException - in case something goes wrong during the export
  - getPluginId
```
public String getPluginId()
```
    Gets the plugin id.
    
    Returns:
    
    the plugin id
  - setPluginId
```
public void setPluginId(String configId)
```
    Sets the plugin id.
    
    Parameters:
    
    configId - the new plugin id
  - getTypeId
```
@Deprecated
public String getTypeId()
```
    Deprecated. use getPluginId()
    
    Gets the plugin id.
    
    Specified by:
    
    getTypeId in interface CheckResultSourceInterface
    
    Specified by:
    
    getTypeId in interface ResourceHolderInterface
    
    Returns:
    
    The Type ID of the resource holder. The Type ID is the system-defined type identifier (like TRANS or SORT).
  - setTypeId
```
@Deprecated
public void setTypeId(String typeId)
```
    Deprecated. use setPluginId(String)
    
    Sets the plugin id.
  - getDialogClassName
```
@Deprecated
public String getDialogClassName()
```
    Deprecated. As of release 8.1, use annotated-based dialog instead PluginDialog
    
    This returns the expected name for the dialog that edits a job entry. The expected name is in the org.pentaho.di.ui tree and has a class name that is the name of the job entry with 'Dialog' added to the end. e.g. if the job entry is org.pentaho.di.job.entries.zipfile.JobEntryZipFile the dialog would be org.pentaho.di.ui.job.entries.zipfile.JobEntryZipFileDialog If the dialog class for a job entry does not match this pattern it should override this method and return the appropriate class name
    
    Returns:
    
    full class name of the dialog
  - getHolderType
```
public String getHolderType()
```
    Returns the holder type for the job entry
    
    Specified by:
    
    getHolderType in interface ResourceHolderInterface
    
    Returns:
    
    the holder type for the job entry
    
    See Also:
    
    ResourceHolderInterface.getHolderType()
  - getVariables
```
protected VariableSpace getVariables()
```
    Gets the variable bindings for the job entry.
    
    Returns:
    
    the variable bindings for the job entry.
  - setRepository
```
public void setRepository(Repository repository)
```
    Sets the repository for the job entry.
    
    Parameters:
    
    repository - the repository
  - getRepository
```
public Repository getRepository()
```
    Gets the repository for the job entry.
    
    Returns:
    
    the repository
  - setParentJob
```
public void setParentJob(Job parentJob)
```
    Sets the parent job.
    
    Parameters:
    
    parentJob - the new parent job
  - getParentJob
```
public Job getParentJob()
```
    Gets the parent job.
    
    Returns:
    
    the parent job
  - isBasic
```
public boolean isBasic()
```
    Checks if the logging level is basic.
    
    Returns:
    
    true if the logging level is basic, false otherwise
  - isDetailed
```
public boolean isDetailed()
```
    Checks if the logging level is detailed.
    
    Returns:
    
    true if the logging level is detailed, false otherwise
  - isDebug
```
public boolean isDebug()
```
    Checks if the logging level is debug.
    
    Returns:
    
    true if the logging level is debug, false otherwise
  - isRowlevel
```
public boolean isRowlevel()
```
    Checks if the logging level is rowlevel.
    
    Returns:
    
    true if the logging level is rowlevel, false otherwise
  - logMinimal
```
public void logMinimal(String message)
```
    Logs the specified string at the minimal level.
    
    Parameters:
    
    message - the message
  - logMinimal
```
public void logMinimal(String message,
                       Object... arguments)
```
    Logs the specified string and arguments at the minimal level.
    
    Parameters:
    
    message - the message
    
    arguments - the arguments
  - logBasic
```
public void logBasic(String message)
```
    Logs the specified string at the basic level.
    
    Parameters:
    
    message - the message
  - logBasic
```
public void logBasic(String message,
                     Object... arguments)
```
    Logs the specified string and arguments at the basic level.
    
    Parameters:
    
    message - the message
    
    arguments - the arguments
  - logDetailed
```
public void logDetailed(String message)
```
    Logs the specified string at the detailed level.
    
    Parameters:
    
    message - the message
  - logDetailed
```
public void logDetailed(String message,
                        Object... arguments)
```
    Logs the specified string and arguments at the detailed level.
    
    Parameters:
    
    message - the message
    
    arguments - the arguments
  - logDebug
```
public void logDebug(String message)
```
    Logs the specified string at the debug level.
    
    Parameters:
    
    message - the message
  - logDebug
```
public void logDebug(String message,
                     Object... arguments)
```
    Logs the specified string and arguments at the debug level.
    
    Parameters:
    
    message - the message
    
    arguments - the arguments
  - logRowlevel
```
public void logRowlevel(String message)
```
    Logs the specified string at the row level.
    
    Parameters:
    
    message - the message
  - logRowlevel
```
public void logRowlevel(String message,
                        Object... arguments)
```
    Logs the specified string and arguments at the row level.
    
    Parameters:
    
    message - the message
    
    arguments - the arguments
  - logError
```
public void logError(String message)
```
    Logs the specified string at the error level.
    
    Parameters:
    
    message - the message
  - logError
```
public void logError(String message,
                     Throwable e)
```
    Logs the specified string and Throwable object at the error level.
    
    Parameters:
    
    message - the message
    
    e - the e
  - logError
```
public void logError(String message,
                     Object... arguments)
```
    Logs the specified string and arguments at the error level.
    
    Parameters:
    
    message - the message
    
    arguments - the arguments
  - getLogChannel
```
public LogChannelInterface getLogChannel()
```
    Gets the log channel.
    
    Returns:
    
    the log channel
  - getLogChannelId
```
public String getLogChannelId()
```
    Gets the logging channel id
    
    Specified by:
    
    getLogChannelId in interface LoggingObjectInterface
    
    Returns:
    
    the log channel id
    
    See Also:
    
    LoggingObjectInterface.getLogChannelId()
  - getObjectName
```
public String getObjectName()
```
    Gets the object name
    
    Specified by:
    
    getObjectName in interface LoggingObjectInterface
    
    Returns:
    
    the object name
    
    See Also:
    
    LoggingObjectInterface.getObjectName()
  - getObjectCopy
```
public String getObjectCopy()
```
    Gets a string identifying a copy in a series of steps
    
    Specified by:
    
    getObjectCopy in interface LoggingObjectInterface
    
    Returns:
    
    a string identifying a copy in a series of steps
    
    See Also:
    
    LoggingObjectInterface.getObjectCopy()
  - getObjectRevision
```
public ObjectRevision getObjectRevision()
```
    Gets the revision of the object with respect to a repository
    
    Specified by:
    
    getObjectRevision in interface LoggingObjectInterface
    
    See Also:
    
    LoggingObjectInterface.getObjectRevision()
  - getObjectType
```
public LoggingObjectType getObjectType()
```
    Gets the logging object type
    
    Specified by:
    
    getObjectType in interface LoggingObjectInterface
    
    Returns:
    
    the logging object type
    
    See Also:
    
    LoggingObjectInterface.getObjectType()
  - getParent
```
public LoggingObjectInterface getParent()
```
    Gets the logging object interface's parent
    
    Specified by:
    
    getParent in interface LoggingObjectInterface
    
    Returns:
    
    the logging object interface's parent
    
    See Also:
    
    LoggingObjectInterface.getParent()
  - getRepositoryDirectory
```
public RepositoryDirectory getRepositoryDirectory()
```
    Gets the directory of the job entry in the repository. For JobEntryBase, this returns null
    
    Specified by:
    
    getRepositoryDirectory in interface LoggingObjectInterface
    
    Returns:
    
    null
    
    See Also:
    
    LoggingObjectInterface.getRepositoryDirectory()
  - getLogLevel
```
public LogLevel getLogLevel()
```
    Gets the logging level for the job entry
    
    Specified by:
    
    getLogLevel in interface LoggingObjectInterface
    
    See Also:
    
    LoggingObjectInterface.getLogLevel()
  - setLogLevel
```
public void setLogLevel(LogLevel logLevel)
```
    Sets the logging level for the job entry
    
    Parameters:
    
    logLevel - the new log level
  - getContainerObjectId
```
public String getContainerObjectId()
```
    Gets the container object id
    
    Specified by:
    
    getContainerObjectId in interface LoggingObjectInterface
    
    Returns:
    
    the container object id
  - setContainerObjectId
```
public void setContainerObjectId(String containerObjectId)
```
    Sets the container object id
    
    Parameters:
    
    containerObjectId - the container object id to set
  - getRegistrationDate
```
public Date getRegistrationDate()
```
    Returns the registration date for the job entry. For JobEntryBase, this method always returns null
    
    Specified by:
    
    getRegistrationDate in interface LoggingObjectInterface
    
    Returns:
    
    null
  - hasRepositoryReferences
```
public boolean hasRepositoryReferences()
```
    Checks whether the job entry has repository references. For JobEntryBase, this method always returns false
    
    Returns:
    
    false
  - lookupRepositoryReferences
```
public void lookupRepositoryReferences(Repository repository)
                                throws KettleException
```
    Looks up the references after import
    
    Parameters:
    
    repository - the repository to reference.
    
    Throws:
    
    KettleException - if any errors occur during the lookup
  - getReferencedObjectDescriptions
```
public String[] getReferencedObjectDescriptions()
```
    Returns:
    
    The objects referenced in the step, like a a transformation, a job, a mapper, a reducer, a combiner, ...
  - isReferencedObjectEnabled
```
public boolean[] isReferencedObjectEnabled()
```
    Returns:
    
    true for each referenced object that is enabled or has a valid reference definition.
  - loadReferencedObject
```
@Deprecated
public Object loadReferencedObject(int index,
                                               Repository rep,
                                               VariableSpace space)
                                        throws KettleException
```
    Deprecated. use loadReferencedObject(int, Repository, IMetaStore, VariableSpace)
    
    Load the referenced object
    
    Parameters:
    
    index - the referenced object index to load (in case there are multiple references)
    
    rep - the repository
    
    space - the variable space to use
    
    Returns:
    
    the referenced object once loaded
    
    Throws:
    
    KettleException
  - loadReferencedObject
```
public Object loadReferencedObject(int index,
                                   Repository rep,
                                   org.pentaho.metastore.api.IMetaStore metaStore,
                                   VariableSpace space)
                            throws KettleException
```
    Load the referenced object
    
    Parameters:
    
    index - the referenced object index to load (in case there are multiple references)
    
    rep - the repository
    
    metaStore - the metaStore to load from
    
    space - the variable space to use
    
    Returns:
    
    the referenced object once loaded
    
    Throws:
    
    KettleException
  - isGatheringMetrics
```
public boolean isGatheringMetrics()
```
    Specified by:
    
    isGatheringMetrics in interface LoggingObjectInterface
  - setGatheringMetrics
```
public void setGatheringMetrics(boolean gatheringMetrics)
```
    Specified by:
    
    setGatheringMetrics in interface LoggingObjectInterface
  - isForcingSeparateLogging
```
public boolean isForcingSeparateLogging()
```
    Specified by:
    
    isForcingSeparateLogging in interface LoggingObjectInterface
  - setForcingSeparateLogging
```
public void setForcingSeparateLogging(boolean forcingSeparateLogging)
```
    Specified by:
    
    setForcingSeparateLogging in interface LoggingObjectInterface
  - getMetaStore
```
public org.pentaho.metastore.api.IMetaStore getMetaStore()
```
  - setMetaStore
```
public void setMetaStore(org.pentaho.metastore.api.IMetaStore metaStore)
```
  - setAttributesMap
```
public void setAttributesMap(Map<String,Map<String,String>> attributesMap)
```
    Specified by:
    
    setAttributesMap in interface AttributesInterface
  - getAttributesMap
```
public Map<String,Map<String,String>> getAttributesMap()
```
    Specified by:
    
    getAttributesMap in interface AttributesInterface
  - setAttribute
```
public void setAttribute(String groupName,
                         String key,
                         String value)
```
    Specified by:
    
    setAttribute in interface AttributesInterface
  - setAttributes
```
public void setAttributes(String groupName,
                          Map<String,String> attributes)
```
    Specified by:
    
    setAttributes in interface AttributesInterface
  - getAttributes
```
public Map<String,String> getAttributes(String groupName)
```
    Specified by:
    
    getAttributes in interface AttributesInterface
  - getAttribute
```
public String getAttribute(String groupName,
                           String key)
```
    Specified by:
    
    getAttribute in interface AttributesInterface
  - getExtensionDataMap
```
public Map<String,Object> getExtensionDataMap()
```
    Specified by:
    
    getExtensionDataMap in interface ExtensionDataInterface
  - getParentJobMeta
```
public JobMeta getParentJobMeta()
```
    Returns:
    
    The parent jobMeta at save and during execution.
  - setParentJobMeta
```
public void setParentJobMeta(JobMeta parentJobMeta)
```
    At save and run time, the system will attempt to set the jobMeta so that it can be accessed by the jobEntries if necessary.
    
    Parameters:
    
    parentJobMeta - the JobMeta to which this JobEntryInterface belongs
  - getEntryStepSetVariablesMap
```
protected Map<String,String> getEntryStepSetVariablesMap()
```
    Gets a Map of variables set in EntryStepSetVariables
    
    Returns:
    
    a map of variable names and values
  - setEntryStepSetVariable
```
public void setEntryStepSetVariable(String variableName,
                                    String variableValue)
```
    Sets the value of the specified EntryStepSetVariable
  - getEntryStepSetVariable
```
public String getEntryStepSetVariable(String variableName)
```
    Gets the value of the specified EntryStepSetVariable
  - addDatetimeToFilename
```
protected String addDatetimeToFilename(String filename,
                                       boolean addDate,
                                       String datePattern,
                                       boolean addTime,
                                       String timePattern,
                                       boolean specifyFormat,
                                       String datetimeFormat)
```
    Appends the date, time and/or datetime to the given filename (before the extension if it exists), using the provided patterns.
    
    Parameters:
    
    filename - the original filename (can have path and variables)
    
    addDate - if the date is to be added
    
    datePattern - the pattern to be used for the date
    
    addTime - if the time is to be added
    
    timePattern - the pattern to be used for the time
    
    specifyFormat - if the datetime is to be added
    
    datetimeFormat - the pattern to be used for the datetime
    
    Returns:
    
    the resulting filename after adding the specified suffixes to the given filename

Class JobEntryBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.pentaho.di.core.variables.VariableSpace

Field Detail

variables

entryStepSetVariablesMap

rep

parentJob

log

containerObjectId

metaStore

attributesMap

extensionDataMap

parentJobMeta

Constructor Detail

JobEntryBase

JobEntryBase

Method Detail

equals

hashCode

clear

setObjectId

setID

getObjectId

getTypeDesc

setName

getName

setDescription

getDescription

setChanged

setChanged

hasChanged

isStart

isDummy

isEvaluation

isJob

isMail

isShell

isSpecial

isTransformation

isFTP

isSFTP

isHTTP

getXML

loadXML

loadXML

loadXML

parseRepositoryObjects

loadRep

loadRep

saveRep

saveRep

clone

toString

resetErrorsBeforeExecution

evaluates

isUnconditional

getSQLStatements

getSQLStatements

getSQLStatements

getFilename

getRealFilename

getUsedDatabaseConnections

copyVariablesFrom

environmentSubstitute

environmentSubstitute

fieldSubstitute

getParentVariableSpace

setParentVariableSpace

getVariable

getVariable

getBooleanValueOfVariable

initializeVariablesFrom

listVariables

setVariable

shareVariablesWith

injectVariables