fr.gouv.vitam.common.model

Class ItemStatus

java.lang.Object

fr.gouv.vitam.common.model.ItemStatus

public class ItemStatus
extends Object

Composite Item Status

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	data
protected String	globalOutcomeDetailSubcode
protected ProcessState	globalState
protected StatusCode	globalStatus
protected String	itemId
protected String	message
protected List<Integer>	statusMeter

Constructor Summary

Constructors

Constructor and Description
ItemStatus() Empty Constructor
ItemStatus(String itemId) Constructor
ItemStatus(String itemId, String message, StatusCode globalStatus, List<Integer> statusMeter, Map<String,Object> data, LinkedHashMap<String,ItemStatus> itemsStatus, String evDetailData, ProcessState globalState)

Method Summary

Modifier and Type	Method and Description
String	computeStatusMeterMessage()
Map<String,Object>	getData() Deprecated.
Object	getData(String key)
String	getEvDetailData()
String	getGlobalOutcomeDetailSubcode()
ProcessState	getGlobalState() Get the global state
StatusCode	getGlobalStatus()
String	getItemId()
Map<String,ItemStatus>	getItemsStatus()
String	getLogbookTypeProcess()
Map<String,Object>	getMasterData()
String	getMessage()
List<Integer>	getStatusMeter()
LinkedHashMap<String,ItemStatus>	getSubTaskStatus()
protected ItemStatus	increment(ItemStatus itemStatus1, ItemStatus itemStatus2)
ItemStatus	increment(StatusCode statusCode)
ItemStatus	increment(StatusCode statusCode, int increment)
void	reinitStatusMeter() Reinit all the values of this statusMeter to 0
ItemStatus	setData(String key, Object value)
ItemStatus	setEvDetailData(String evDetailData) set EvDetailData
void	setGlobalOutcomeDetailSubcode(String globalOutcomeDetailSubcode)
ItemStatus	setGlobalState(ProcessState globalState)
ItemStatus	setItemId(String itemId)
ItemStatus	setItemsStatus(ItemStatus compositeItemStatus)
ItemStatus	setItemsStatus(String itemId, ItemStatus statusDetails)
ItemStatus	setLogbookTypeProcess(String logbookTypeProcess)
ItemStatus	setMasterData(String key, Object value)
ItemStatus	setMessage(String message)
void	setStatusMeterValue(StatusCode statusCode, Integer value) Set the value of the specified statusCode in this statusMeter
ItemStatus	setSubTaskStatus(String taskId, ItemStatus taskStatus)
boolean	shallStop(boolean blocking)

Methods inherited from class java.lang.Object

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

Field Detail

itemId

protected String itemId

message

protected String message

globalStatus

protected StatusCode globalStatus

statusMeter

protected List<Integer> statusMeter

data

protected Map<String,Object> data

globalState

protected ProcessState globalState

globalOutcomeDetailSubcode

protected String globalOutcomeDetailSubcode

Constructor Detail

ItemStatus

public ItemStatus()

Empty Constructor

ItemStatus

public ItemStatus(String itemId,
                  String message,
                  StatusCode globalStatus,
                  List<Integer> statusMeter,
                  Map<String,Object> data,
                  LinkedHashMap<String,ItemStatus> itemsStatus,
                  String evDetailData,
                  ProcessState globalState)

Parameters:

message -

itemId -

statusMeter -

globalStatus -

data -

itemsStatus -

evDetailData -

globalState -

ItemStatus

public ItemStatus(String itemId)

Constructor

Parameters:

itemId -

Method Detail

getMessage

public String getMessage()

Returns:

the message

setMessage

public ItemStatus setMessage(String message)

Parameters:

message - the message to set

Returns:

this

getItemId

public String getItemId()

Returns:

the itemId

setItemId

public ItemStatus setItemId(String itemId)

Parameters:

itemId - the itemId to set

Returns:

this

getStatusMeter

public List<Integer> getStatusMeter()

Returns:

the statusMeter

increment

public ItemStatus increment(StatusCode statusCode)

Parameters:

statusCode - the statusCode to increment

Returns:

this

increment

public ItemStatus increment(StatusCode statusCode,
                            int increment)

Parameters:

statusCode - the statusCode to increment

increment -

Returns:

this

increment

protected ItemStatus increment(ItemStatus itemStatus1,
                               ItemStatus itemStatus2)

Parameters:

itemStatus1 - the statusCode to increment

itemStatus2 -

Returns:

this

getGlobalStatus

public StatusCode getGlobalStatus()

Returns:

the globalStatus

getData

public Object getData(String key)

Returns:

the data

getData

@Deprecated
public Map<String,Object> getData()

Deprecated.

Returns:

setData

public ItemStatus setData(String key,
                          Object value)

Parameters:

key -

value -

Returns:

this

getMasterData

public Map<String,Object> getMasterData()

Returns:

masterData

setMasterData

public ItemStatus setMasterData(String key,
                                Object value)

Parameters:

key -

value -

Returns:

this

computeStatusMeterMessage

public String computeStatusMeterMessage()

Returns:

String message

getItemsStatus

public Map<String,ItemStatus> getItemsStatus()

Returns:

the itemsStatus

setItemsStatus

public ItemStatus setItemsStatus(String itemId,
                                 ItemStatus statusDetails)

Parameters:

itemId -

statusDetails -

Returns:

this

setItemsStatus

public ItemStatus setItemsStatus(ItemStatus compositeItemStatus)

Parameters:

compositeItemStatus -

Returns:

this

getGlobalState

public ProcessState getGlobalState()

Get the global state

Returns:

globalState as type ProcessState

setGlobalState

public ItemStatus setGlobalState(ProcessState globalState)

Parameters:

globalState - the golbal state to set

Returns:

this

shallStop

public boolean shallStop(boolean blocking)

Parameters:

blocking - True if the step or handler is blocking

Returns:

True if this item shall stop the Step or Handler

getSubTaskStatus

public LinkedHashMap<String,ItemStatus> getSubTaskStatus()

Returns:

the subTaskStatus

setSubTaskStatus

public ItemStatus setSubTaskStatus(String taskId,
                                   ItemStatus taskStatus)

Parameters:

taskId - the taskId to set

taskStatus - the taskStatus to set

Returns:

this

getEvDetailData

public String getEvDetailData()

Returns:

evDetailData

setEvDetailData

public ItemStatus setEvDetailData(String evDetailData)

set EvDetailData

Parameters:

evDetailData -

Returns:

this

getLogbookTypeProcess

public String getLogbookTypeProcess()

setLogbookTypeProcess

public ItemStatus setLogbookTypeProcess(String logbookTypeProcess)

getGlobalOutcomeDetailSubcode

public String getGlobalOutcomeDetailSubcode()

setGlobalOutcomeDetailSubcode

public void setGlobalOutcomeDetailSubcode(String globalOutcomeDetailSubcode)

setStatusMeterValue

public void setStatusMeterValue(StatusCode statusCode,
                                Integer value)

Set the value of the specified statusCode in this statusMeter

Parameters:

statusCode -

value -

reinitStatusMeter

public void reinitStatusMeter()

Reinit all the values of this statusMeter to 0