BatchJob ( @enterprise 10.0 API)

java.lang.Object
- com.groiss.store.PersistentObject
- - com.groiss.wf.batch.BatchJob

All Implemented Interfaces:

KeyValuePair<String,String>, Persistent, Serializable, Cloneable
```
public class BatchJob
extends PersistentObject
```
Captures state information about batch jobs. Basically, each batchjob is in one of four normal life cycle states or one of two error states. First it is CREATED, then it is STARTED, then it is FINISHED and afterwards it is COMPLETED. It may also be manually ABORTED.
The specific life cycle may be much more complex, according to behavioral modification flags and timer interaction.
Please note that setting properties of the BatchJob should be achieved via the mark* methods of BatchManager.
When updates on a BatchJob instance via its setters need to be made, the following pattern is recommended in order to account for concurrent modifications by other threads:
```
 doStart(BatchJob job) {
   ...
   job = BatchManager.getFreshBatchJob(job);
   job.setResultValues("my results");
   store.update(job);
 }
 
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABORTED` State for aborted instances.
`static int`	`COMPLETED` State for completed instances.
`static int`	`COMPLETEDERRORHANDLING` error handling has been completed
`static int`	`CREATED` Initial state for the instance.
`static int`	`FINISHED` State for finished instances.
`static int`	`FINISHERROR` State for instances which could not be finished by the BatchManager or the corresponding executor.
`static int`	`FINISHERRORHANDLING` error handling for batchjobs which couln't be finished is currently active
`static int`	`FINISHERRORHANDLINGFAILED` error handling is defined for this batchjob, but it did fail to start
`static int`	`FINISHERRORHANDLINGPENDING` error handling for batchjobs which couldn't be finished will be started soon
`static int`	`STARTED` State for started instances.
`static int`	`STARTERROR` State for instances which could not be started.
`static int`	`STARTERRORHANDLING` error handling for batchjobs which couln't be started is currently active
`static int`	`STARTERRORHANDLINGFAILED` error handling is defined for this batchjob, but it did fail to start
`static int`	`STARTERRORHANDLINGPENDING` error handling for batchjobs which couldn't be started will be started soon

Fields inherited from class com.groiss.store.PersistentObject
filled, oid

Fields inherited from interface com.groiss.store.Persistent
emptyKeys

Constructor Summary

Constructors
Modifier	Constructor and Description
	`BatchJob()` Create an empty BatchJob instance.
`protected`	`BatchJob(String jobtype, int jobstate, ActivityInstance context, String params)` Create a BatchJob instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Date`	`getAborttime()` Get the time the instance was aborted.
`Date`	`getCompletiontime()` Get the time the instance was completed.
`ActivityInstance`	`getContext()` The process context in which the instance was submitted.
`Date`	`getCreationtime()` Get the time the instance was created.
`String`	`getExecutor()`
`Date`	`getFinishtime()` Get the time the instance was finished.
`int`	`getJobstate()` The state of the instance.
`String`	`getJobtype()` The jobtype of the instance.
`Date`	`getLastpolltime()`
`Date`	`getLastStartTryTime()` Get the time of the last start attempt.
`String`	`getParams()` Get the parameters for the job execution.
`int`	`getPollAttemptCount()` Gets the number of poll attempts to far.
`long`	`getPollInterval()` Gets the poll interval.
`int`	`getResultcode()` Get the resultcode of the instance.
`String`	`getResultvalues()` Get the resultvalues of the instance.
`int`	`getStartAttemptCount()` Gets the number of start attempts to far.
`long`	`getStartInterval()` Gets the start interval.
`Date`	`getStarttime()` Get the time the instance was started or is about to be started.
`String`	`getStateName()`
`static String`	`getStateName(int state)`
`String`	`getTableName()` This method must return the table name of the database table in which this persistent object is stored.
`boolean`	`isAutofinish()` Determine whether the instance is to be finished automatically ('autofinish' in WDL).
`boolean`	`isGoBackOnError()` Determine whether an error during start or poll of the instance will force the engine to go back to the latest interactive step ('gobackonerror' in WDL).
`boolean`	`isNewthread()` Determine whether the instance start and poll attempts are to be made in a new thread ('newthread' in WDL).
`boolean`	`isPollFinish()` Determine whether a job should be polled for being finished ('pollfinish' in WDL) by the BatchManager or a corresponding executor.
`boolean`	`isResumable()` Determines if the batch job is resumable.
`boolean`	`isRetryStart()` Determine whether erroneous starts will be retried later on ('retrystart' in WDL) by the BatchManager or a corresponding executor.
`boolean`	`isStartnow()` Determine whether the instance is to be started immediately ('startnow' in WDL).
`boolean`	`isSuspendable()` Determine if the batch job is suspendable.
`void`	`setAborttime(Date aborttime)`
`void`	`setAutofinish(boolean autofinish)` Set the autofinish property of the instance.
`void`	`setCompletiontime(Date completiontime)`
`void`	`setContext(ActivityInstance context)`
`void`	`setCreationtime(Date creationtime)`
`void`	`setExecutor(String executor)` Set the executor of the instance.
`void`	`setFinishtime(Date finishtime)`
`void`	`setGoBackOnError(boolean gobackonerror)` Set the gobackonerror property of the instance.
`void`	`setJobstate(int jobstate)`
`void`	`setJobtype(String jobtype)`
`protected void`	`setLastPollTime(Date lastpolltime)`
`protected void`	`setLastStartTryTime(Date laststarttrytime)`
`void`	`setNewthread(boolean newthread)` Set the newthread property of the instance.
`void`	`setParams(String params)` Set the params field of the instance.
`protected void`	`setPollAttemptCount(int pollattemptcount)`
`void`	`setPollFinish(boolean pollfinish)` Set the pollfinish property of the instance.
`void`	`setPollInterval(long pollinterval)` Set the poll interval of an instance.
`void`	`setResultcode(int resultcode)` Set the resultcode of the instance.
`void`	`setResultvalues(String resultvalues)` Set the resultvalues.
`void`	`setRetryStart(boolean retrystart)` Set the retrystart property of the instance.
`protected void`	`setStartAttemptCount(int startattemptcount)`
`void`	`setStartInterval(long startinterval)` Set the start interval of an instance.
`void`	`setStartnow(boolean startnow)` Set the startnow property of the instance.
`void`	`setStarttime(Date starttime)` Set the time the instance should be started.
`String`	`toString()`

Methods inherited from class com.groiss.store.PersistentObject
afterDelete, afterInsert, afterRead, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, clone, dbFields, equals, getKey, getKeys, getLocalClassName, getLocalObjectName, getOid, getStore, getValue, hashCode, isFilled, isValid, onDelete, onInsert, onRead, onUpdate, setFilled, setOid, setOid, setStore, toListString

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

- Field Detail
  - CREATED
```
public static final int CREATED
```
    Initial state for the instance. Immediately after it is created. External execution context do not yet know about batchjobs in this state. The BatchManager (or corresponding executor) periodically looks for jobs in this state and starts them.
    
    See Also:
    
    Constant Field Values
  - STARTED
```
public static final int STARTED
```
    State for started instances. The batchJob is in the external execution context. The workflow engine does nothing with jobs in this state. If the batchjob has been set to be a polling one, the BatchManager (or assigned executor) will periodically call BatchAdapter.doPoll(BatchJob).
    
    See Also:
    
    Constant Field Values
  - FINISHED
```
public static final int FINISHED
```
    State for finished instances. The batchJob was finished in the external execution context. The BatchManager (or corresponding executor) periodically checks for jobs in this state and completes them. Especially, the originating task of the BatchJob is finished.
    
    See Also:
    
    Constant Field Values
  - COMPLETED
```
public static final int COMPLETED
```
    State for completed instances. The batchJob was completed by the BatchManager or corresponding executor. The workflow engine does nothing with jobs in this state.
    
    See Also:
    
    Constant Field Values
  - ABORTED
```
public static final int ABORTED
```
    State for aborted instances. The cancellation was issued manually. The workflow engine does nothing with jobs in this state.
    
    See Also:
    
    Constant Field Values
  - STARTERROR
```
public static final int STARTERROR
```
    State for instances which could not be started. E.g. where doStart of the BatchAdapter threw an Exception. The workflow engine does nothing with jobs in this state.
    
    See Also:
    
    Constant Field Values
  - FINISHERROR
```
public static final int FINISHERROR
```
    State for instances which could not be finished by the BatchManager or the corresponding executor. E.g. where beforeCompletion of the BatchAdapter threw an Exception. The workflow engine does nothing with jobs in this state.
    
    See Also:
    
    Constant Field Values
  - STARTERRORHANDLING
```
public static final int STARTERRORHANDLING
```
    error handling for batchjobs which couln't be started is currently active
    
    See Also:
    
    Constant Field Values
  - FINISHERRORHANDLING
```
public static final int FINISHERRORHANDLING
```
    error handling for batchjobs which couln't be finished is currently active
    
    See Also:
    
    Constant Field Values
  - COMPLETEDERRORHANDLING
```
public static final int COMPLETEDERRORHANDLING
```
    error handling has been completed
    
    See Also:
    
    Constant Field Values
  - STARTERRORHANDLINGPENDING
```
public static final int STARTERRORHANDLINGPENDING
```
    error handling for batchjobs which couldn't be started will be started soon
    
    See Also:
    
    Constant Field Values
  - FINISHERRORHANDLINGPENDING
```
public static final int FINISHERRORHANDLINGPENDING
```
    error handling for batchjobs which couldn't be finished will be started soon
    
    See Also:
    
    Constant Field Values
  - STARTERRORHANDLINGFAILED
```
public static final int STARTERRORHANDLINGFAILED
```
    error handling is defined for this batchjob, but it did fail to start
    
    See Also:
    
    Constant Field Values
  - FINISHERRORHANDLINGFAILED
```
public static final int FINISHERRORHANDLINGFAILED
```
    error handling is defined for this batchjob, but it did fail to start
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BatchJob
```
protected BatchJob(String jobtype,
                   int jobstate,
                   ActivityInstance context,
                   String params)
```
    Create a BatchJob instance.
    
    Parameters:
    
    jobtype - a String
    
    jobstate - an int
    
    context - a ActivityInstance
    
    params - a String
  - BatchJob
```
public BatchJob()
```
    Create an empty BatchJob instance.
- Method Detail
  - getTableName
```
public String getTableName()
```
    Description copied from interface: Persistent
    
    This method must return the table name of the database table in which this persistent object is stored.
    
    Returns:
    
    The table name of the database table in which this persistent object is stored.
  - setStartnow
```
public void setStartnow(boolean startnow)
```
    Set the startnow property of the instance.
  - isStartnow
```
public boolean isStartnow()
```
    Determine whether the instance is to be started immediately ('startnow' in WDL). If true, the BatchManager is not involved with the start of the job, it is started immediately after creation.
  - setAutofinish
```
public void setAutofinish(boolean autofinish)
```
    Set the autofinish property of the instance.
  - isAutofinish
```
public boolean isAutofinish()
```
    Determine whether the instance is to be finished automatically ('autofinish' in WDL). If true, the job is marked as finished as soon as the doStart method of the specified BatchAdapter terminates.
    
    See Also:
    
    BatchAdapter.doStart(com.groiss.wf.batch.BatchJob)
  - setNewthread
```
public void setNewthread(boolean newthread)
```
    Set the newthread property of the instance.
  - isNewthread
```
public boolean isNewthread()
```
    Determine whether the instance start and poll attempts are to be made in a new thread ('newthread' in WDL).
    At job creation, a new thread is started immediately after job creation ant this threas executes the start and possibly (if autofinishe is set) the finishing of the batch job.
    If the job is being polled for finish, this wioll also take place in a new thread.
  - setGoBackOnError
```
public void setGoBackOnError(boolean gobackonerror)
```
    Set the gobackonerror property of the instance.
  - isGoBackOnError
```
public boolean isGoBackOnError()
```
    Determine whether an error during start or poll of the instance will force the engine to go back to the latest interactive step ('gobackonerror' in WDL). If false, the process will remain at this step.
  - setRetryStart
```
public void setRetryStart(boolean retrystart)
```
    Set the retrystart property of the instance.
  - isRetryStart
```
public boolean isRetryStart()
```
    Determine whether erroneous starts will be retried later on ('retrystart' in WDL) by the BatchManager or a corresponding executor.
  - setPollFinish
```
public void setPollFinish(boolean pollfinish)
```
    Set the pollfinish property of the instance.
  - isPollFinish
```
public boolean isPollFinish()
```
    Determine whether a job should be polled for being finished ('pollfinish' in WDL) by the BatchManager or a corresponding executor.
  - setJobtype
```
public void setJobtype(String jobtype)
```
  - getJobtype
```
public String getJobtype()
```
    The jobtype of the instance.
    
    Returns:
    
    a Classname of a BatchAdapter which is responsible for event handling for this instance.
  - getExecutor
```
public String getExecutor()
```
  - setExecutor
```
public void setExecutor(String executor)
```
    Set the executor of the instance. Typically used in afterCreate() of the BatchAdapter. Must be the id of an existing @enterprise timer with class BatchManager. This timer will be used for the instances start and poll attempts. If not set, the BatchManager will be used as the instances executor.
    The calling thread must update the batchjob afterwards.
    
    Parameters:
    
    executor - the id of the timer to use as the executor of this instance.
  - setJobstate
```
public void setJobstate(int jobstate)
```
  - getJobstate
```
public int getJobstate()
```
    The state of the instance.
    
    Returns:
    
    an int representing the execution state of the instance.
  - setContext
```
public void setContext(ActivityInstance context)
```
  - getContext
```
public ActivityInstance getContext()
```
    The process context in which the instance was submitted.
    
    Returns:
    
    a ActivityInstance which represents the TASK where the instance was submitted.
  - setParams
```
public void setParams(String params)
```
    Set the params field of the instance.
  - getParams
```
public String getParams()
```
    Get the parameters for the job execution. Must be interpreted by the BatchAdapter.
    
    Returns:
    
    a String containing parameters for execution.
  - setResultvalues
```
public void setResultvalues(String resultvalues)
```
    Set the resultvalues. Not interpreted by the BatchManager.
    
    Parameters:
    
    resultvalues - a String
  - getResultvalues
```
public String getResultvalues()
```
    Get the resultvalues of the instance.
    
    Returns:
    
    a String representing some result of the instances execution.
  - setResultcode
```
public void setResultcode(int resultcode)
```
    Set the resultcode of the instance. Not interpreted by the BatchManager.
    
    Parameters:
    
    resultcode - an int representing a coded result of the instances execution
  - getResultcode
```
public int getResultcode()
```
    Get the resultcode of the instance.
    
    Returns:
    
    an int with the coded result of the execution of the instance.
  - setCreationtime
```
public void setCreationtime(Date creationtime)
```
  - getCreationtime
```
public Date getCreationtime()
```
    Get the time the instance was created.
    
    Returns:
    
    a Date
  - setStarttime
```
public void setStarttime(Date starttime)
```
    Set the time the instance should be started. If null, then it is started at the next run of the BatchManager. Otherwise it is started in the first run of the BatchManager which takes place after the starttime.
  - getStarttime
```
public Date getStarttime()
```
    Get the time the instance was started or is about to be started. If null
    
    Returns:
    
    a Date
  - setFinishtime
```
public void setFinishtime(Date finishtime)
```
  - getFinishtime
```
public Date getFinishtime()
```
    Get the time the instance was finished.
    
    Returns:
    
    a Date
  - setCompletiontime
```
public void setCompletiontime(Date completiontime)
```
  - getCompletiontime
```
public Date getCompletiontime()
```
    Get the time the instance was completed.
    
    Returns:
    
    a Date
  - getLastStartTryTime
```
public Date getLastStartTryTime()
```
    Get the time of the last start attempt.
    
    Returns:
    
    time of the last start attempt
  - getAborttime
```
public Date getAborttime()
```
    Get the time the instance was aborted.
    
    Returns:
    
    a Date
  - setAborttime
```
public void setAborttime(Date aborttime)
```
  - setLastStartTryTime
```
protected void setLastStartTryTime(Date laststarttrytime)
```
  - getStartAttemptCount
```
public int getStartAttemptCount()
```
    Gets the number of start attempts to far.
    
    Returns:
    
    the number of start attempts
  - setStartAttemptCount
```
protected void setStartAttemptCount(int startattemptcount)
```
  - getStartInterval
```
public long getStartInterval()
```
    Gets the start interval.
    
    Returns:
    
    the start interval (seconds)
  - setStartInterval
```
public void setStartInterval(long startinterval)
```
    Set the start interval of an instance. Calls to the Adapters doStartl() method will not be made more often than this interval.
    
    Parameters:
    
    startinterval - the interval to use (seconds)
  - getLastpolltime
```
public Date getLastpolltime()
```
    Returns:
  - setLastPollTime
```
protected void setLastPollTime(Date lastpolltime)
```
  - getPollAttemptCount
```
public int getPollAttemptCount()
```
    Gets the number of poll attempts to far.
    
    Returns:
    
    the number of poll attempts
  - setPollAttemptCount
```
protected void setPollAttemptCount(int pollattemptcount)
```
  - getPollInterval
```
public long getPollInterval()
```
    Gets the poll interval.
    
    Returns:
    
    the poll interval (seconds)
  - setPollInterval
```
public void setPollInterval(long pollinterval)
```
    Set the poll interval of an instance. Calls to the Adapters doPoll() method will not be made more often than this interval.
    
    Parameters:
    
    pollinterval - the interval to use (seconds)
  - isSuspendable
```
public boolean isSuspendable()
```
    Determine if the batch job is suspendable.
    
    Returns:
    
    true, if the batch job is suspendable
  - isResumable
```
public boolean isResumable()
```
    Determines if the batch job is resumable.
    
    Returns:
    
    true,if the batch job is resumable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getStateName
```
public String getStateName()
```
  - getStateName
```
public static String getStateName(int state)
```

Class BatchJob

Field Summary

Fields inherited from class com.groiss.store.PersistentObject

Fields inherited from interface com.groiss.store.Persistent

Constructor Summary

Method Summary

Methods inherited from class com.groiss.store.PersistentObject

Methods inherited from class java.lang.Object

Field Detail

CREATED

STARTED

FINISHED

COMPLETED

ABORTED

STARTERROR

FINISHERROR

STARTERRORHANDLING

FINISHERRORHANDLING

COMPLETEDERRORHANDLING

STARTERRORHANDLINGPENDING

FINISHERRORHANDLINGPENDING

STARTERRORHANDLINGFAILED

FINISHERRORHANDLINGFAILED

Constructor Detail

BatchJob

BatchJob

Method Detail

getTableName

setStartnow

isStartnow

setAutofinish

isAutofinish

setNewthread

isNewthread

setGoBackOnError

isGoBackOnError

setRetryStart

isRetryStart

setPollFinish

isPollFinish

setJobtype

getJobtype

getExecutor

setExecutor

setJobstate

getJobstate

setContext

getContext

setParams

getParams

setResultvalues

getResultvalues

setResultcode

getResultcode

setCreationtime

getCreationtime

setStarttime

getStarttime

setFinishtime

getFinishtime

setCompletiontime

getCompletiontime

getLastStartTryTime

getAborttime

setAborttime

setLastStartTryTime

getStartAttemptCount

setStartAttemptCount

getStartInterval

setStartInterval

getLastpolltime

setLastPollTime

getPollAttemptCount

setPollAttemptCount

getPollInterval

setPollInterval

isSuspendable

isResumable

toString

getStateName