merge into HEAD from BRANCHES/V1.3

svn merge svn://www.alfresco.org:3691/alfresco/BRANCHES/V1.3@2980 svn://www.alfresco.org:3691/alfresco/BRANCHES/V1.3@2981 .


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@3015 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/web/bean/actions/IHandler.java

@@ -0,0 +1,70 @@
+package org.alfresco.web.bean.actions;
+
+import java.io.Serializable;
+import java.util.Map;
+
+import javax.faces.context.FacesContext;
+
+import org.alfresco.web.bean.wizard.IWizardBean;
+
+/**
+ * Interface definition for a handler, classes that are responsible
+ * for marshalling data between the repository and the action based 
+ * wizards.
+ * 
+ * @author gavinc
+ */
+public interface IHandler
+{
+   /**
+    * Adds any properties to the given map that need default values
+    * before the UI is displayed to the user.
+    * 
+    * @param props The current properties map
+    */
+   public void setupUIDefaults(Map<String, Serializable> props);
+   
+   /**
+    * By default, a JSP with the same name as the handler will
+    * be loaded from a default location. If the handler has stored 
+    * it's UI somewhere else the view id can be returned from this method.
+    * 
+    * @return The path to the JSP for the handler
+    */
+   public String getJSPPath();
+   
+   /**
+    * Called at the end of the wizard. The properties relevant to 
+    * this handler have to be placed in the repository properties 
+    * map in the correct form for sending to the node service.
+    * 
+    * @param props The current properties map
+    * @param repoProps The repository properties map to prepare
+    */
+   public void prepareForSave(Map<String, Serializable> props,
+                              Map<String, Serializable> repoProps);
+   
+   /**
+    * Called at the start of the edit wizard. The repository properties
+    * map holds the current state of this rule. Any properties relevant
+    * to this handler should be retrieved and setup in the current 
+    * properties map.
+    * 
+    * @param props The current properties map
+    * @param repoParams The properties currently in the repository
+    */
+   public void prepareForEdit(Map<String, Serializable> props,
+                              Map<String, Serializable> repoProps);
+   
+   /**
+    * Generates a summary string for this handler. The current state of 
+    * the wizard is passed as well as the current properties map.
+    * 
+    * @param context Faces context
+    * @param wizard The current wizard
+    * @param props The properties map
+    * @return The summary string
+    */
+   public String generateSummary(FacesContext context, IWizardBean wizard, 
+                                 Map<String, Serializable> props);
+}