Package com.yworkflow.instance.error

Class InvalidWorkflowInstanceStatusException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.yworkflow.common.error.WorkflowException

com.yworkflow.instance.error.InvalidWorkflowInstanceStatusException

All Implemented Interfaces:

Serializable

public class InvalidWorkflowInstanceStatusException
extends WorkflowException

Exception thrown when an invalid status transition is attempted on a workflow instance. InvalidWorkflowInstanceStatusException is used to indicate that a workflow instance cannot transition from its current status to the requested new status.

Since:

1.0

See Also:

• WorkflowException
• WorkflowInstanceStatus
• WorkflowInstance
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InvalidWorkflowInstanceStatusException(WorkflowInstanceStatus actualStatus)	Creates a new InvalidWorkflowInstanceStatusException with the specified statuses.
InvalidWorkflowInstanceStatusException(WorkflowInstanceStatus actualStatus, WorkflowInstanceStatus newStatus)	Creates a new InvalidWorkflowInstanceStatusException with the specified statuses.

Method Summary

Modifier and Type	Method	Description
WorkflowInstanceStatus	getActualStatus()	Returns the actual current status of the workflow instance.
Optional<WorkflowInstanceStatus>	getNewStatus()	Returns the requested new status that is invalid.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

InvalidWorkflowInstanceStatusException

public InvalidWorkflowInstanceStatusException(WorkflowInstanceStatus actualStatus,
 WorkflowInstanceStatus newStatus)

Creates a new InvalidWorkflowInstanceStatusException with the specified statuses.

Parameters:

actualStatus - the current status of the workflow instance

newStatus - the requested new status that is invalid

InvalidWorkflowInstanceStatusException

public InvalidWorkflowInstanceStatusException(WorkflowInstanceStatus actualStatus)

Creates a new InvalidWorkflowInstanceStatusException with the specified statuses.

Parameters:

actualStatus - the current status of the workflow instance

Method Details

getActualStatus

public WorkflowInstanceStatus getActualStatus()

Returns the actual current status of the workflow instance.

Returns:

the current status

getNewStatus

public Optional<WorkflowInstanceStatus> getNewStatus()

Returns the requested new status that is invalid.

Returns:

the requested new status