com.mulesoft.mule.runtime.module.batch.engine

Interface BatchJobInstanceAdapter

All Superinterfaces:

BatchJobInstance, Serializable

All Known Implementing Classes:

DefaultBatchJobInstance

public interface BatchJobInstanceAdapter
extends BatchJobInstance

Adapter interface to access BatchJobInstance related functionality that we don't want exposed as part of the API

Since:

3.5.0

Method Summary

Modifier and Type	Method and Description
BatchEvent	getBatchEvent() Returns the BatchEvent that was used to start this instance
String	getQueueName() Returns the name of the queue that this instance uses to pipeline its records
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 interface com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance

getCreationTime, getId, getOwnerJobName, getRecordCount, getResult, getStatus

Method Detail

setStatus

void setStatus(BatchJobInstanceStatus status)

Sets the status for this instance

Parameters:

status - a BatchJobInstanceStatus

setRecordCount

void setRecordCount(long recordCount)

Sets the number of records this instance is bound to process

Parameters:

recordCount - a positive integer greater than zero

getBatchEvent

BatchEvent getBatchEvent()

Returns the BatchEvent that was used to start this instance

Returns:

a BatchEvent

getQueueName

String getQueueName()

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

Returns:

a non empty String

setQueueName

void setQueueName(String queueName)

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

Parameters:

queueName - a non empty String