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>

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

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

Author:

Philip Helger

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
org.joda.time.Duration	getDuration()
org.joda.time.LocalDateTime	getEndDateTime()
com.helger.commons.state.ESuccess	getExecutionSuccess()
String	getID()
com.helger.commons.text.IReadonlyMultiLingualText	getJobDescription()
LongRunningJobResult	getResult()
org.joda.time.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

Constructor Detail

LongRunningJobData

public LongRunningJobData(@Nonnull@Nonempty
                  String sJobID,
                  @Nonnull
                  com.helger.commons.text.IReadonlyMultiLingualText 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.IReadonlyMultiLingualText getJobDescription()

Returns:

The description of the underlying job. Never null.

getStartDateTime

@Nonnull
public org.joda.time.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 org.joda.time.LocalDateTime getEndDateTime()

Returns:

The date and time when the job execution finished

getDuration

@Nonnull
public org.joda.time.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