Package com.avoka.fc.core.service.job

Class ActionResult

java.lang.Object

com.avoka.fc.core.service.job.ActionResult

public class ActionResult
extends Object

Provides the Job Action result class.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ActionResult.Status	The delivery status values.

Constructor Summary

Constructors

Constructor	Description
ActionResult(ActionResult.Status status)	Create a new ActionResult object with the given status.

Method Summary

Modifier and Type	Method	Description
Date	getExpiryTime()
Integer	getMaxRetryAttempts()
Integer	getMaxRetryAttepts()	Deprecated. use getMaxRetryAttempts() instead
String	getMessage()
Date	getNextRetryAttempt()
String	getRoute()
String	getStatus()
boolean	isStatusError()
void	setExpiryTime(Date expiryTime)
void	setMaxRetryAttempts(Integer maxRetryAttempts)
void	setMaxRetryAttepts(Integer maxRetryAttepts)	Deprecated. use setMaxRetryAttempts(Integer) instead
void	setMessage(String message)
void	setNextRetryAttempt(Date nextRetryAttempt)
void	setRoute(String route)
static ActionResult.Status	toActionStatus(String status)	Return the corresponding Status enumeration for the text status.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionResult

public ActionResult(ActionResult.Status status)

Create a new ActionResult object with the given status.

Parameters:

status - the result status

Method Detail

getRoute

public String getRoute()

Returns:

the route

setRoute

public void setRoute(String route)

Parameters:

route - the route to set

getStatus

public String getStatus()

Returns:

the status

isStatusError

public boolean isStatusError()

Returns:

true if the action result status was 'Error'

getNextRetryAttempt

public Date getNextRetryAttempt()

Returns:

the nextRetryAttempt

setNextRetryAttempt

public void setNextRetryAttempt(Date nextRetryAttempt)

Parameters:

nextRetryAttempt - the nextRetryAttempt to set

getMaxRetryAttempts

public Integer getMaxRetryAttempts()

Returns:

the maxRetryAttempts

setMaxRetryAttempts

public void setMaxRetryAttempts(Integer maxRetryAttempts)

Parameters:

maxRetryAttempts - the maxRetryAttempts to set

getMaxRetryAttepts

@Deprecated
public Integer getMaxRetryAttepts()

Deprecated.

use getMaxRetryAttempts() instead

Returns:

the maxRetryAttempts

setMaxRetryAttepts

@Deprecated
public void setMaxRetryAttepts(Integer maxRetryAttepts)

Deprecated.

use setMaxRetryAttempts(Integer) instead

Parameters:

maxRetryAttepts - the maxRetryAttempts to set

getExpiryTime

public Date getExpiryTime()

Returns:

the expiryTime

setExpiryTime

public void setExpiryTime(Date expiryTime)

Parameters:

expiryTime - the expiryTime to set

getMessage

public String getMessage()

Returns:

the action result message

setMessage

public void setMessage(String message)

Parameters:

message - the action result message

toActionStatus

public static ActionResult.Status toActionStatus(String status)

Return the corresponding Status enumeration for the text status.

Parameters:

status - the text status value (required)

Returns:

the corresponding Status enumeration for the text status

Since:

5.0

toString

public String toString()

Overrides:

toString in class Object

Returns:

the string representation of this object.