Package net.solarnetwork.central.domain

Class BaseClaimableJob<C,R,S extends ClaimableJobState,PK extends Comparable<PK> & Serializable>

java.lang.Object

net.solarnetwork.central.domain.BaseObjectIdentity<PK>

net.solarnetwork.central.dao.BaseObjectEntity<PK>

net.solarnetwork.central.domain.BaseClaimableJob<C,R,S,PK>

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PK>, ClaimableJob<C,R,S,PK>, net.solarnetwork.dao.Entity<PK>, net.solarnetwork.domain.Identity<PK>

public abstract class BaseClaimableJob<C,R,S extends ClaimableJobState,PK extends Comparable<PK> & Serializable>
extends BaseObjectEntity<PK>
implements ClaimableJob<C,R,S,PK>

Abstract implementation support for ClaimableJob.

Since:

1.44

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BaseClaimableJob()

Method Summary

Modifier and Type	Method	Description
Instant	getCompleted()	Get the completed date.
C	getConfiguration()	Get the job configuration details.
String	getGroupKey()	Get a job group key.
S	getJobState()	Get the job state.
char	getJobStateKey()	Get the job state key value.
Boolean	getJobSuccess()	Get a success flag.
String	getMessage()	Get a message about the result.
double	getPercentComplete()	Get a percentage complete for the job overall.
R	getResult()	Get the number of datum successfully loaded.
Instant	getStarted()	Get the date the job started execution.
String	getTokenId()	Get the authorization token associated with this job, if any.
boolean	isSuccess()	Get the success flag.
void	setCompleted(Instant completed)
void	setConfiguration(C configuration)
void	setGroupKey(String groupKey)
void	setJobState(S jobState)
void	setJobSuccess(Boolean jobSuccess)
void	setMessage(String message)
void	setPercentComplete(double percentComplete)
void	setResult(R result)
void	setStarted(Instant started)
void	setTokenId(String tokenId)	Set the authorization token ID.

Methods inherited from class net.solarnetwork.central.dao.BaseObjectEntity

getCreated, getModified, setCreated, setModified

Methods inherited from class net.solarnetwork.central.domain.BaseObjectIdentity

clone, compareTo, equals, getId, hashCode, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.solarnetwork.central.domain.ClaimableJob

getJobDuration

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface net.solarnetwork.dao.Entity

getCreated

Methods inherited from interface net.solarnetwork.domain.Identity

getId, hasId

Constructor Details

BaseClaimableJob

public BaseClaimableJob()

Method Details

getJobState

public S getJobState()

Description copied from interface: ClaimableJob

Get the job state.

Specified by:

getJobState in interface ClaimableJob<C,R,S extends ClaimableJobState,PK extends Comparable<PK> & Serializable>

Returns:

the job state

getJobStateKey

public char getJobStateKey()

Get the job state key value.

Returns:

the key value, or ClaimableJobState.UNKNOWN_KEY if not known

setJobState

public void setJobState(S jobState)

getConfiguration

public C getConfiguration()

Description copied from interface: ClaimableJob

Get the job configuration details.

Specified by:

getConfiguration in interface ClaimableJob<C,R,S extends ClaimableJobState,PK extends Comparable<PK> & Serializable>

Returns:

the job configuration

setConfiguration

public void setConfiguration(C configuration)

getResult

public R getResult()

Description copied from interface: ClaimableJob

Get the number of datum successfully loaded.

Note that even if ClaimableJob.getJobSuccess() is false this method can return a value greater than 0, if partial results are supported by the transaction mode of the import process.

Specified by:

getResult in interface ClaimableJob<C,R,S extends ClaimableJobState,PK extends Comparable<PK> & Serializable>

Returns:

the number of successfully loaded datum

setResult

public void setResult(R result)

getTokenId

public String getTokenId()

Description copied from interface: ClaimableJob

Get the authorization token associated with this job, if any.

Specified by:

getTokenId in interface ClaimableJob<C,R,S extends ClaimableJobState,PK extends Comparable<PK> & Serializable>

Returns:

the authorization token, or null if none

setTokenId

public void setTokenId(String tokenId)

Set the authorization token ID.

Parameters:

tokenId - the token ID to set

Since:

2.1

getJobSuccess

public Boolean getJobSuccess()

Description copied from interface: ClaimableJob

Get a success flag.

Specified by:

getJobSuccess in interface ClaimableJob<C,R,S extends ClaimableJobState,PK extends Comparable<PK> & Serializable>

Returns:

the success flag, or null if not known

setJobSuccess

public void setJobSuccess(Boolean jobSuccess)

isSuccess

public boolean isSuccess()

Get the success flag.

Returns:

true if getJobSuccess() is true

getMessage

public String getMessage()

Description copied from interface: ClaimableJob

Get a message about the result.

If ClaimableJob.getJobSuccess() returns false, this method will return a message about the error.

Specified by:

getMessage in interface ClaimableJob<C,R,S extends ClaimableJobState,PK extends Comparable<PK> & Serializable>

Returns:

a message

setMessage

public void setMessage(String message)

getStarted

public Instant getStarted()

Description copied from interface: ClaimableJob

Get the date the job started execution.

Specified by:

getStarted in interface ClaimableJob<C,R,S extends ClaimableJobState,PK extends Comparable<PK> & Serializable>

Returns:

the started date or null if not started

setStarted

public void setStarted(Instant started)

getCompleted

public Instant getCompleted()

Description copied from interface: ClaimableJob

Get the completed date.

Specified by:

getCompleted in interface ClaimableJob<C,R,S extends ClaimableJobState,PK extends Comparable<PK> & Serializable>

Returns:

the completed date, or null if not complete

setCompleted

public void setCompleted(Instant completed)

getPercentComplete

public double getPercentComplete()

Description copied from interface: ClaimableJob

Get a percentage complete for the job overall.

Specified by:

getPercentComplete in interface ClaimableJob<C,R,S extends ClaimableJobState,PK extends Comparable<PK> & Serializable>

Returns:

a percentage complete, or -1 if not known

setPercentComplete

public void setPercentComplete(double percentComplete)

getGroupKey

public String getGroupKey()

Description copied from interface: ClaimableJob

Get a job group key.

A group key represents a grouping of related jobs, such that only one job within a given group should be allowed to execute at a time. This provides a way to synchronize multiple related jobs in a reliable manner.

Specified by:

getGroupKey in interface ClaimableJob<C,R,S extends ClaimableJobState,PK extends Comparable<PK> & Serializable>

Returns:

the group key, or null for the "default" group

setGroupKey

public void setGroupKey(String groupKey)