com.helger.photon.basic.longrun

Class LongRunningJobData

java.lang.Object

com.helger.photon.basic.longrun.LongRunningJobData

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, Serializable

@NotThreadSafe
public final class LongRunningJobData
extends Object
implements com.helger.commons.id.IHasID<String>, Serializable

This class contains the data for a single long running job.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LongRunningJobData(String sJobID, com.helger.commons.text.IMultilingualText aJobDescription, String sStartingUserID)

Method Summary

Modifier and Type	Method and Description
Duration	getDuration()
LocalDateTime	getEndDateTime()
com.helger.commons.state.ESuccess	getExecutionSuccess()
String	getID()
com.helger.commons.text.IMultilingualText	getJobDescription()
LongRunningJobResult	getResult()
LocalDateTime	getStartDateTime()
String	getStartingUserID()
boolean	isEnded()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID

Constructor Detail

LongRunningJobData

public LongRunningJobData(@Nonnull @Nonempty
                          String sJobID,
                          @Nonnull
                          com.helger.commons.text.IMultilingualText aJobDescription,
                          @Nullable
                          String sStartingUserID)

Method Detail

getID

@Nonnull
 @Nonempty
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

getJobDescription

@Nonnull
public com.helger.commons.text.IMultilingualText getJobDescription()

Returns:

The description of the underlying job. Never null.

getStartDateTime

@Nonnull
public LocalDateTime getStartDateTime()

Returns:

The date time when the job was started. Never null.

getStartingUserID

@Nullable
public String getStartingUserID()

Returns:

The user who started the job. May be null.

isEnded

public boolean isEnded()

Returns:

true if this job was already ended

getEndDateTime

@Nullable
public LocalDateTime getEndDateTime()

Returns:

The date and time when the job execution finished

getDuration

@Nonnull
public Duration getDuration()

Returns:

The execution duration. Never null.

getExecutionSuccess

@Nullable
public com.helger.commons.state.ESuccess getExecutionSuccess()

Returns:

The technical success indicator, whether the scheduled job ran without an exception.

getResult

@Nullable
public LongRunningJobResult getResult()

Returns:

The semantic result of the execution.

toString

public String toString()

Overrides:

toString in class Object