com.mulesoft.mule.runtime.module.batch.internal

Class DefaultBatchJobInstance

java.lang.Object

com.mulesoft.mule.runtime.module.batch.internal.DefaultBatchJobInstance

All Implemented Interfaces:

BatchJobInstance, BatchJobInstanceAdapter, Serializable

public class DefaultBatchJobInstance
extends Object
implements BatchJobInstanceAdapter

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultBatchJobInstance(String id, String ownerJobName, org.mule.runtime.core.api.event.CoreEvent muleEvent)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
BatchEvent	getBatchEvent() Returns the BatchEvent that was used to start this instance
Date	getCreationTime() The instant at which this instance was created.
String	getId() Returns the id of this execution.
String	getOwnerJobName() The name of the BatchJob that spawned this instance
String	getQueueName() Returns the name of the queue that this instance uses to pipeline its records
long	getRecordCount() Returns the total number of records that this instance is bound to process
BatchJobResult	getResult() Reflects the final result of the job execution.
BatchJobInstanceStatus	getStatus() Returns this instance's status
int	hashCode()
void	setQueueName(String queueName) sets the name of the queue that this instance uses to pipeline its records
void	setRecordCount(long recordCount) Sets the number of records this instance is bound to process
void	setStatus(BatchJobInstanceStatus status) Sets the status for this instance

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultBatchJobInstance

public DefaultBatchJobInstance(String id,
                               String ownerJobName,
                               org.mule.runtime.core.api.event.CoreEvent muleEvent)

Method Detail

getId

public String getId()

Returns the id of this execution. This id has to be unique for all instances of the same job

Specified by:

getId in interface BatchJobInstance

Returns:

a non empty String

getResult

public BatchJobResult getResult()

Reflects the final result of the job execution. This object is updated on the fly so that it also reflects partial progress

Specified by:

getResult in interface BatchJobInstance

Returns:

a BatchJobResult

getStatus

public BatchJobInstanceStatus getStatus()

Returns this instance's status

Specified by:

getStatus in interface BatchJobInstance

Returns:

a BatchJobInstanceStatus

setStatus

public void setStatus(BatchJobInstanceStatus status)

Sets the status for this instance

Specified by:

setStatus in interface BatchJobInstanceAdapter

Parameters:

status - a BatchJobInstanceStatus

getRecordCount

public long getRecordCount()

Returns the total number of records that this instance is bound to process

Specified by:

getRecordCount in interface BatchJobInstance

Returns:

a positive integer greater than zero

setRecordCount

public void setRecordCount(long recordCount)

Sets the number of records this instance is bound to process

Specified by:

setRecordCount in interface BatchJobInstanceAdapter

Parameters:

recordCount - a positive integer greater than zero

getCreationTime

public Date getCreationTime()

The instant at which this instance was created.

Specified by:

getCreationTime in interface BatchJobInstance

Returns:

a not null Date

getOwnerJobName

public String getOwnerJobName()

The name of the BatchJob that spawned this instance

Specified by:

getOwnerJobName in interface BatchJobInstance

Returns:

a non empty String

getBatchEvent

public BatchEvent getBatchEvent()

Returns the BatchEvent that was used to start this instance

Specified by:

getBatchEvent in interface BatchJobInstanceAdapter

Returns:

a BatchEvent

getQueueName

public String getQueueName()

Returns the name of the queue that this instance uses to pipeline its records

Specified by:

getQueueName in interface BatchJobInstanceAdapter

Returns:

a non empty String

setQueueName

public void setQueueName(String queueName)

sets the name of the queue that this instance uses to pipeline its records

Specified by:

setQueueName in interface BatchJobInstanceAdapter

Parameters:

queueName - a non empty String

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object