com.broadleafcommerce.jobsevents.domain

Class ProcessStatusImpl

java.lang.Object

com.broadleafcommerce.jobsevents.domain.ProcessStatusImpl

All Implemented Interfaces:

ProcessStatus

@Entity
public class ProcessStatusImpl
extends Object
implements ProcessStatus

Author:

Jeff Fischer

See Also:

ProcessStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description
protected Long	executionId
protected String	executionType
protected String	friendlyName
protected Long	id
protected Character	isArchived
protected Character	isPaused
protected Date	lastUpdated
protected String	name
protected Double	percentComplete
protected Long	processId
protected Integer	version

Constructor Summary

Constructors

Constructor and Description
ProcessStatusImpl()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDescription() Any additional, descriptive information about the process
Long	getExecutionId() Relates to the primary key of another, arbitrary entity.
String	getExecutionType() Relates to a descriptive type that ties this to an asynchronous thread of execution.
String	getFriendlyName() Name used by the system in a human-readable format
Long	getId() Primary key
Boolean	getIsArchived() Whether or not this ProcessStatus is considered to be archived.
Boolean	getIsPaused() Whether or not this ProcessStatus is considered to be in a paused state.
Date	getLastUpdated() The last time this ProcessStatus was touched by the KeepAlive process.
String	getName() Name used by the system to identify the process
Double	getPercentComplete() The level of completion of the asynchronous thread of execution currently achieved.
Long	getProcessId() A system generated identifier for the process
int	hashCode()
void	setDescription(String description)
void	setExecutionId(Long executionId)
void	setExecutionType(String executionType)
void	setFriendlyName(String friendlyName)
void	setId(Long id)
void	setIsArchived(Boolean isArchived)
void	setIsPaused(Boolean isPaused)
void	setLastUpdated(Date lastUpdated)
void	setName(String name)
void	setPercentComplete(Double percentComplete)
void	setProcessId(Long processId)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

id

protected Long id

name

protected String name

friendlyName

protected String friendlyName

description

protected String description

processId

protected Long processId

executionId

protected Long executionId

executionType

protected String executionType

isPaused

protected Character isPaused

percentComplete

protected Double percentComplete

lastUpdated

protected Date lastUpdated

isArchived

protected Character isArchived

version

protected Integer version

Constructor Detail

ProcessStatusImpl

public ProcessStatusImpl()

Method Detail

getId

public Long getId()

Description copied from interface: ProcessStatus

Primary key

Specified by:

getId in interface ProcessStatus

Returns:

setId

public void setId(Long id)

Specified by:

setId in interface ProcessStatus

getName

public String getName()

Description copied from interface: ProcessStatus

Name used by the system to identify the process

Specified by:

getName in interface ProcessStatus

Returns:

setName

public void setName(String name)

Specified by:

setName in interface ProcessStatus

getFriendlyName

public String getFriendlyName()

Description copied from interface: ProcessStatus

Name used by the system in a human-readable format

Specified by:

getFriendlyName in interface ProcessStatus

Returns:

setFriendlyName

public void setFriendlyName(String friendlyName)

Specified by:

setFriendlyName in interface ProcessStatus

getDescription

public String getDescription()

Description copied from interface: ProcessStatus

Any additional, descriptive information about the process

Specified by:

getDescription in interface ProcessStatus

Returns:

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface ProcessStatus

getProcessId

public Long getProcessId()

Description copied from interface: ProcessStatus

A system generated identifier for the process

Specified by:

getProcessId in interface ProcessStatus

Returns:

setProcessId

public void setProcessId(Long processId)

Specified by:

setProcessId in interface ProcessStatus

getExecutionId

public Long getExecutionId()

Description copied from interface: ProcessStatus

Relates to the primary key of another, arbitrary entity. Should be used by an asynchronous thread of execution to associate this process with key entity from that process. This is generally set via ProcessManager.setExecution(Long, String).

Specified by:

getExecutionId in interface ProcessStatus

Returns:

setExecutionId

public void setExecutionId(Long executionId)

Specified by:

setExecutionId in interface ProcessStatus

getExecutionType

public String getExecutionType()

Description copied from interface: ProcessStatus

Relates to a descriptive type that ties this to an asynchronous thread of execution. Using executionType and ProcessStatus.getExecutionId() in tandem allow for pinpointing a particular ProcessStatus instance for a given asynchronous thread of execution. This is generally set via ProcessManager.setExecution(Long, String).

Specified by:

getExecutionType in interface ProcessStatus

Returns:

setExecutionType

public void setExecutionType(String executionType)

Specified by:

setExecutionType in interface ProcessStatus

getIsPaused

public Boolean getIsPaused()

Description copied from interface: ProcessStatus

Whether or not this ProcessStatus is considered to be in a paused state. Paused processes are considered to be no longer processing and are in a holding state waiting for an arbitrary action to be taken to resume the work being done. This is useful for processes that that pause/resume logic. This is generally set via ProcessManager.pauseProcess().

Specified by:

getIsPaused in interface ProcessStatus

Returns:

setIsPaused

public void setIsPaused(Boolean isPaused)

Specified by:

setIsPaused in interface ProcessStatus

getIsArchived

public Boolean getIsArchived()

Description copied from interface: ProcessStatus

Whether or not this ProcessStatus is considered to be archived. Archived processes are considered not "live" and are only intended for historical data. Archived processes are purged from the system completely after a configurable amount of time (AbandonedProcessWorkerImpl.abandonedPurgeThresholdSeconds)

Specified by:

getIsArchived in interface ProcessStatus

Returns:

setIsArchived

public void setIsArchived(Boolean isArchived)

Specified by:

setIsArchived in interface ProcessStatus

getPercentComplete

public Double getPercentComplete()

Description copied from interface: ProcessStatus

The level of completion of the asynchronous thread of execution currently achieved. This is generally updated by the asynchronous thread of execution via ProcessManager.setProgress(long, long).

This will return the decimal percentage. For display purposes this will likely need to be multiplied by 100

Specified by:

getPercentComplete in interface ProcessStatus

Returns:

setPercentComplete

public void setPercentComplete(Double percentComplete)

Specified by:

setPercentComplete in interface ProcessStatus

getLastUpdated

public Date getLastUpdated()

Description copied from interface: ProcessStatus

The last time this ProcessStatus was touched by the KeepAlive process.

Specified by:

getLastUpdated in interface ProcessStatus

Returns:

See Also:

KeepAliveWorkerImpl

setLastUpdated

public void setLastUpdated(Date lastUpdated)

Specified by:

setLastUpdated in interface ProcessStatus

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object