org.qubership.automation.itf.core.model.jpa.context

Class TcContext

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

org.json.simple.JSONObject

org.qubership.automation.itf.core.model.jpa.context.JsonContext

org.qubership.automation.itf.core.model.jpa.context.JsonStorable

org.qubership.automation.itf.core.model.jpa.context.TcContext

All Implemented Interfaces:

Serializable, Cloneable, Map, org.json.simple.JSONAware, org.json.simple.JSONStreamAware, Identified<Object>, Named, OptimisticLockable<Object>, Prefixed, Storable, Extendable, IJsonContext

@Entity
public class TcContext
extends JsonStorable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	TC

Fields inherited from class org.qubership.automation.itf.core.model.jpa.context.JsonStorable

startTime

Constructor Summary

Constructors

Constructor and Description
TcContext() TODO: Add JavaDoc.
TcContext(Storable parent, Map parameters)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object anObject)
void	fillBindingKeys(Set<String> renderendContextKeys)
void	fillInstances(List<AbstractContainerInstance> instances)
void	fillReportLinks(Map<String,String> reportLinks)
Date	getDuration() Compute duration of the context execution.
int	getDurationMinutes() Compute duration of the context execution.
Environment	getEnvironmentById()
AbstractContainerInstance	getInitiator()
List<AbstractContainerInstance>	getInstances()
boolean	getStartedByAtp()
StartedFrom	getStartedFrom()
int	hashCode()
Boolean	isFailEventSent()
boolean	isFinished()
Boolean	isFinishEventSent()
boolean	isNeedToReportToAtp()
boolean	isNeedToReportToItf()
boolean	isNotified()
boolean	isRunnable() Method returns true if state change from the current state to IN_PROGRESS is valid.
boolean	isRunning()
boolean	isRunStepByStep()
boolean	isStartValidation()
boolean	isValidationFailed()
void	setAndCalculateNeedToReportToItf() Calculate and set needToReportToItf field.
void	setFailEventAsSent()
void	setFinishEventAsSent()
void	setInitiator(AbstractContainerInstance initiator)
protected void	setInstances(List<AbstractContainerInstance> instances)
void	setNeedToReportToAtp(boolean needToReportToAtp)
void	setNeedToReportToItf(boolean needToReportToItf)
void	setNotified(boolean notified)
void	setRunStepByStep(boolean runStepByStep)
void	setStartedByAtp(boolean startedByAtp)
void	setStartedFrom(StartedFrom startedFrom)
void	setStartValidation(boolean startValidation)
void	setTimeToLive()
void	setValidationFailed(boolean validationFailed)

Methods inherited from class org.qubership.automation.itf.core.model.jpa.context.JsonStorable

contains, copy, findRootObject, findUsages, flush, getDescription, getExtendsParameters, getID, getName, getNaturalId, getParent, getPrefix, getStartTime, getStorableProp, getStoreInformationDelegate, getVersion, move, performActionsForImportIntoAnotherProject, performPostCopyActions, performPostImportActions, performPostImportActionsParent, remove, replicate, returnSimpleParent, setDescription, setID, setName, setNaturalId, setParent, setPrefix, setStartTime, setStorableProp, setVersion, store, toString, upStorableVersion

Methods inherited from class org.qubership.automation.itf.core.model.jpa.context.JsonContext

containsKey, create, create, extend, fromJson, get, get, getCast, getExtension, getExtensionsJson, getHistory, getJsonString, isCollectHistory, merge, mergeMap, put, putAll, putIfAbsent, setCollectHistory, setExtensionsJson, setJsonString

Methods inherited from class org.json.simple.JSONObject

escape, toJSONString, toJSONString, toString, writeJSONString, writeJSONString

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsValue, entrySet, forEach, getOrDefault, isEmpty, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.qubership.automation.itf.core.model.common.Storable

getProjectId, setProjectId

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsValue, entrySet, forEach, getOrDefault, isEmpty, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface org.json.simple.JSONAware

toJSONString

Field Detail

TC

public static final String TC

See Also:

Constant Field Values

Constructor Detail

TcContext

public TcContext()

TODO: Add JavaDoc.

TcContext

public TcContext(Storable parent,
                 Map parameters)

Method Detail

setTimeToLive

public void setTimeToLive()

fillBindingKeys

public void fillBindingKeys(Set<String> renderendContextKeys)

fillReportLinks

public void fillReportLinks(Map<String,String> reportLinks)

isRunning

public boolean isRunning()

isRunnable

public boolean isRunnable()

Method returns true if state change from the current state to IN_PROGRESS is valid. Scope of the method: - To control state manipulations while context execution, e.g. in the SituationExecutor.

So, direct state manipulations made by a user from UI (re-Run Failed/Stopped context via Context popup or Pause/Resume) are not controlled by this method.

isFinished

public boolean isFinished()

getInstances

public List<AbstractContainerInstance> getInstances()

setInstances

protected void setInstances(List<AbstractContainerInstance> instances)

fillInstances

public void fillInstances(List<AbstractContainerInstance> instances)

getInitiator

public AbstractContainerInstance getInitiator()

setInitiator

public void setInitiator(AbstractContainerInstance initiator)

getDuration

public Date getDuration()

Compute duration of the context execution.

Returns:

computed duration as Date object. In case endTime or startTime are null, return current system Date

getDurationMinutes

public int getDurationMinutes()

Compute duration of the context execution.

Returns:

Int - computed duration in minutes. In case startTime is null, return 0; Otherwize, in case endTime is null, System.currentTimeMillis() is used in calculations. Calculated value is increased by 1.

isStartValidation

public boolean isStartValidation()

setStartValidation

public void setStartValidation(boolean startValidation)

getEnvironmentById

public Environment getEnvironmentById()

getStartedByAtp

public boolean getStartedByAtp()

setStartedByAtp

public void setStartedByAtp(boolean startedByAtp)

isNeedToReportToAtp

public boolean isNeedToReportToAtp()

setNeedToReportToAtp

public void setNeedToReportToAtp(boolean needToReportToAtp)

isNeedToReportToItf

public boolean isNeedToReportToItf()

setNeedToReportToItf

public void setNeedToReportToItf(boolean needToReportToItf)

setAndCalculateNeedToReportToItf

public void setAndCalculateNeedToReportToItf()

Calculate and set needToReportToItf field.

getStartedFrom

public StartedFrom getStartedFrom()

setStartedFrom

public void setStartedFrom(StartedFrom startedFrom)

isFailEventSent

public Boolean isFailEventSent()

setFailEventAsSent

public void setFailEventAsSent()

isFinishEventSent

public Boolean isFinishEventSent()

setFinishEventAsSent

public void setFinishEventAsSent()

isNotified

public boolean isNotified()

setNotified

public void setNotified(boolean notified)

equals

public boolean equals(Object anObject)

Specified by:

equals in interface Map

Overrides:

equals in class JsonStorable

hashCode

public int hashCode()

Specified by:

hashCode in interface Map

Overrides:

hashCode in class JsonStorable

isRunStepByStep

public boolean isRunStepByStep()

setRunStepByStep

public void setRunStepByStep(boolean runStepByStep)

isValidationFailed

public boolean isValidationFailed()

setValidationFailed

public void setValidationFailed(boolean validationFailed)