org.openepics.cable.util

Class StatusTransitionUtil

java.lang.Object

org.openepics.cable.util.StatusTransitionUtil

public class StatusTransitionUtil
extends Object

Utility class that can be user to check if certain status transitions are allowed, or which further statuses can be chosen from.

Author:

Imre Toth

Method Summary

Modifier and Type	Method and Description
static Collection<CableStatus>	possibleStatuses(CableStatus currentStatus) Shows a collection of statuses that can be used during status transition.
static boolean	transitionAllowed(CableStatus currentStatus, CableStatus newStatus) Checks if a transition from one cable status is allowed to another status.

Methods inherited from class java.lang.Object

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

Method Detail

possibleStatuses

public static Collection<CableStatus> possibleStatuses(CableStatus currentStatus)

Shows a collection of statuses that can be used during status transition. Used by the web UI to fill UI element with the possible values

Parameters:

currentStatus - the status for which the allowed status should be returned

Returns:

NULL, if no other statuses can be chosen from, or collection of statuses from which can be chosen during status transition

transitionAllowed

public static boolean transitionAllowed(CableStatus currentStatus,
                                        CableStatus newStatus)

Checks if a transition from one cable status is allowed to another status. Throws StatusTransitionException if transition is not allowed.

Parameters:

currentStatus - the cable status to transform from

newStatus - the new status of the cable to transform to

Returns:

true if transition is allowed, or throws StatusTransitionException

Throws:

StatusTransitionException - if status transition is not allowed, or if any of the status parameters are NULL value. The exception message will contain the possibly allowed statuses