org.kuali.student.enrollment.batchjobresults.infc

Interface BatchJobResult

All Superinterfaces:

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

All Known Implementing Classes:

BatchJobResultInfo

public interface BatchJobResult
extends IdEntity

Object that holds the results of a batch job

Author:

nwright

Method Summary

Methods

Modifier and Type	Method and Description
ContextInfo	getContext() The context under which this batch job was run
List<? extends Attribute>	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.
RichText	getMessage() Messages describing details of the status.
List<? extends Attribute>	getParameters() The parameters or options specified when the batch job was run Note the list may be empty but it cannot be null

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

Method Detail

getParameters

List<? extends Attribute> getParameters()

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

getContext

ContextInfo getContext()

The context under which this batch job was run

getGlobalResults

List<? extends Attribute> getGlobalResults()

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

getItemsProcessed

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. 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

getItemsExpected

Integer getItemsExpected()

Number of items expected to be processed

getMessage

RichText getMessage()

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