diff gnv-artifacts/src/main/java/de/intevation/gnv/transition/Transition.java @ 1119:7c4f81f74c47

merged gnv-artifacts
author Thomas Arendsen Hein <thomas@intevation.de>
date Fri, 28 Sep 2012 12:14:00 +0200
parents f953c9a559d8
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/transition/Transition.java	Fri Sep 28 12:14:00 2012 +0200
@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2010 by Intevation GmbH
+ *
+ * This program is free software under the LGPL (>=v2.1)
+ * Read the file LGPL.txt coming with the software for details
+ * or visit http://www.gnu.org/licenses/ if it does not exist.
+ */
+
+package de.intevation.gnv.transition;
+
+import de.intevation.gnv.state.State;
+
+import java.io.Serializable;
+
+import org.w3c.dom.Node;
+
+/**
+ * This interface describes basic methods necessary for a transition model.
+ *
+ * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
+ *
+ */
+public interface Transition extends Serializable{
+
+    /**
+     * Returns the ID of the State from which the Transition could be used
+     * @return the ID of the State from which the Transition could be used
+     */
+    public String getFrom();
+
+    /**
+     * Returns the ID of the State where it is possible to go as next.
+     * @return the ID of the State where it is possible to go as next.
+     */
+    public String getTo();
+
+    /**
+     * Determines if it is possible to go along this Transition or not.
+     * @param state the current State
+     * @return true, if this transition is valid for the given state - otherwise
+     * false.
+     */
+    public boolean isValid(State state);
+
+    /**
+     * Configures the Transition.
+     * @param configuration
+     */
+    public void setup(Node configuration);
+
+}
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org