org.kuali.student.enrollment.batchjobresults.dto

Class BatchJobResultInfo

java.lang.Object

org.kuali.student.r2.common.dto.HasAttributesInfo

org.kuali.student.r2.common.dto.HasAttributesAndMetaInfo

org.kuali.student.r2.common.dto.TypeStateEntityInfo

org.kuali.student.r2.common.dto.EntityInfo

org.kuali.student.r2.common.dto.IdEntityInfo

org.kuali.student.enrollment.batchjobresults.dto.BatchJobResultInfo

All Implemented Interfaces:

Serializable, BatchJobResult, Entity, HasAttributes, HasAttributesAndMeta, HasId, HasMeta, HasPrimaryKey, HasState, HasType, IdEntity, TypeStateEntity

public class BatchJobResultInfo
extends IdEntityInfo
implements BatchJobResult

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BatchJobResultInfo()
BatchJobResultInfo(BatchJobResult orig) Copies batch job result

Method Summary

Methods

Modifier and Type	Method and Description
ContextInfo	getContext() The context under which this batch job was run
List<AttributeInfo>	getGlobalResults() Any global results of running the batch job This may be a number or a count or a newly created id.
Integer	getItemsExpected() Number of items expected to be processed
Integer	getItemsProcessed() Number of items processed Used to indicate the progress of the batch job The batch job does not have to update this field every time it processes a job it may decide to update it every 10 or 100 or 1000 items processed.
RichTextInfo	getMessage() Messages describing details of the status.
List<AttributeInfo>	getParameters() The parameters or options specified when the batch job was run Note the list may be empty but it cannot be null
void	setContext(ContextInfo context)
void	setGlobalResults(List<AttributeInfo> globalResults)
void	setItemsExpected(Integer itemsExpected)
void	setItemsProcessed(Integer itemsProcessed)
void	setMessage(RichTextInfo message)
void	setParameters(List<AttributeInfo> parameters)

Methods inherited from class org.kuali.student.r2.common.dto.IdEntityInfo

getId, setId

Methods inherited from class org.kuali.student.r2.common.dto.EntityInfo

getDescr, getName, setDescr, setName

Methods inherited from class org.kuali.student.r2.common.dto.TypeStateEntityInfo

getState, getStateKey, getType, getTypeKey, setState, setStateKey, setType, setTypeKey

Methods inherited from class org.kuali.student.r2.common.dto.HasAttributesAndMetaInfo

getMeta, setMeta

Methods inherited from class org.kuali.student.r2.common.dto.HasAttributesInfo

getAttributes, getAttributeValue, getAttributeValueList, setAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.student.r2.common.infc.HasId

getId

Methods inherited from interface org.kuali.student.r2.common.infc.Entity

getDescr, getName

Methods inherited from interface org.kuali.student.r2.common.infc.HasType

getType, getTypeKey

Methods inherited from interface org.kuali.student.r2.common.infc.HasState

getState, getStateKey

Methods inherited from interface org.kuali.student.r2.common.infc.HasAttributes

getAttributes

Methods inherited from interface org.kuali.student.r2.common.infc.HasMeta

getMeta

Constructor Detail

BatchJobResultInfo

public BatchJobResultInfo()

BatchJobResultInfo

public BatchJobResultInfo(BatchJobResult orig)

Copies batch job result

Method Detail

getContext

public ContextInfo getContext()

Description copied from interface: BatchJobResult

The context under which this batch job was run

Specified by:

getContext in interface BatchJobResult

setContext

public void setContext(ContextInfo context)

getGlobalResults

public List<AttributeInfo> getGlobalResults()

Description copied from interface: BatchJobResult

Any global results of running the batch job This may be a number or a count or a newly created id. This is in addition to individual Result Items that may be created. Note the list may be empty but like other lists it must not be null

Specified by:

getGlobalResults in interface BatchJobResult

setGlobalResults

public void setGlobalResults(List<AttributeInfo> globalResults)

getParameters

public List<AttributeInfo> getParameters()

Description copied from interface: BatchJobResult

The parameters or options specified when the batch job was run Note the list may be empty but it cannot be null

Specified by:

getParameters in interface BatchJobResult

setParameters

public void setParameters(List<AttributeInfo> parameters)

getItemsProcessed

public Integer getItemsProcessed()

Description copied from interface: BatchJobResult

Number of items processed Used to indicate the progress of the batch job The batch job does not have to update this field every time it processes a job it may decide to update it every 10 or 100 or 1000 items processed. This can be null if the job has not started yet or there are no items This may or may not correspond with the corresponding Result Items that get created

Specified by:

getItemsProcessed in interface BatchJobResult

setItemsProcessed

public void setItemsProcessed(Integer itemsProcessed)

getItemsExpected

public Integer getItemsExpected()

Description copied from interface: BatchJobResult

Number of items expected to be processed

Specified by:

getItemsExpected in interface BatchJobResult

setItemsExpected

public void setItemsExpected(Integer itemsExpected)

getMessage

public RichTextInfo getMessage()

Description copied from interface: BatchJobResult

Messages describing details of the status. Often left null if the status is that it is complete.

Specified by:

getMessage in interface BatchJobResult

setMessage

public void setMessage(RichTextInfo message)