Package com.polarion.platform.jobs.spi.service

Class JobStatus

java.lang.Object

com.polarion.platform.jobs.spi.service.JobStatus

All Implemented Interfaces:

IJobMultiStatus, IJobStatus, Serializable

public class JobStatus
extends Object
implements IJobMultiStatus

Implementation of IJobMultiStatus.

For simplicity non-multi status is not provided.

Author:

Stepan Roh, Polarion Software

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.polarion.platform.jobs.IJobStatus

IJobStatus.JobStatusType

Constructor Summary

Constructors

Constructor	Description
JobStatus(IJobStatus.JobStatusType type, IJob job, String message, Throwable error)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addNestedStatus(IJobStatus status)	Add nested status.
Throwable	getError()	Exception cause of IJobStatus.JobStatusType.STATUS_TYPE_FAILED (may be omitted).
IJob	getJob()	Job.
String	getMessage()	Status message.
Collection	getNestedStatuses()	Return nested IJobStatuses.
IJobStatus.JobStatusType	getType()	Status type.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

JobStatus

public JobStatus(IJobStatus.JobStatusType type,
 IJob job,
 String message,
 Throwable error)

Constructor.

Parameters:

type - status type

job - job (can be null)

message - message (can be null)

error - error (can be null)

Throws:

IllegalArgumentException - if type is null

Method Details

getType

public IJobStatus.JobStatusType getType()

Description copied from interface: IJobStatus

Status type.

Specified by:

getType in interface IJobStatus

Returns:

IJobStatus.JobStatusType (not null)

getJob

public IJob getJob()

Description copied from interface: IJobStatus

Job.

May return null if used post-mortem.

Specified by:

getJob in interface IJobStatus

Returns:

IJob or null

getMessage

public String getMessage()

Description copied from interface: IJobStatus

Status message.

Specified by:

getMessage in interface IJobStatus

Returns:

message or null

getError

public Throwable getError()

Description copied from interface: IJobStatus

Exception cause of IJobStatus.JobStatusType.STATUS_TYPE_FAILED (may be omitted).

Specified by:

getError in interface IJobStatus

Returns:

exception or null

toString

public String toString()

Overrides:

toString in class Object

addNestedStatus

public void addNestedStatus(IJobStatus status)

Description copied from interface: IJobMultiStatus

Add nested status.

Specified by:

addNestedStatus in interface IJobMultiStatus

Parameters:

status - status to nest

getNestedStatuses

public Collection getNestedStatuses()

Description copied from interface: IJobMultiStatus

Return nested IJobStatuses.

Specified by:

getNestedStatuses in interface IJobMultiStatus

Returns:

Collection of IJobStatuses (not null)