Refactoring of the pseudo file/desktop action code to allow use by AVM and repo filesystem drivers.

Added virtualization view to the AVM filesystem driver that shows all stores and versions using a single
shared filesystem.


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/WCM-DEV2/root@4443 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/filesys/alfresco/DesktopResponse.java

@@ -0,0 +1,237 @@
+/*
+ * Copyright (C) 2005-2006 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.filesys.alfresco;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.mozilla.javascript.ScriptableObject;
+
+/**
+ * Desktop Response Class
+ * 
+ *  <p>Holds the status code, optional status message and optional values returned by a desktop action.
+ *  
+ * @author gkspencer
+ */
+public class DesktopResponse extends ScriptableObject {
+
+	// Version id
+	
+	private static final long serialVersionUID = 6421278986221629296L;
+	
+	//	Desktop action status and optional status message
+	
+	private int m_status;
+	private String m_statusMsg;
+
+	// Optional return values
+	
+	private List<Object> m_responseValues;
+	
+	/**
+	 * Class constructor
+	 * 
+	 * @param sts int
+	 */
+	public DesktopResponse(int sts)
+	{
+		m_status = sts;
+	}
+	
+	/**
+	 * Class constructor
+	 * 
+	 * @param sts int
+	 * @param msg String
+	 */
+	public DesktopResponse(int sts, String msg)
+	{
+		m_status = sts;
+		m_statusMsg = msg;
+	}
+
+	/**
+	 * Javascript constructor
+	 * 
+	 * @param sts int
+	 * @param msg String
+	 */
+	public void jsConstructor(int sts, String msg)
+	{
+		m_status    = sts;
+		m_statusMsg = msg;
+	}
+	
+	/**
+	 * Return the class name
+	 * 
+	 * @return String
+	 */
+	@Override
+	public String getClassName() {
+		return "DesktopResponse";
+	}
+
+	/**
+	 * Return the status code
+	 * 
+	 * @return int
+	 */
+	public final int getStatus()
+	{
+		return m_status;
+	}
+	
+	/**
+	 * Return the status property
+	 * 
+	 * @return int
+	 */
+	public int jsGet_status()
+	{
+		return m_status;
+	}
+	
+	/**
+	 * Determine if there is an optional status message
+	 * 
+	 * @return boolean
+	 */
+	public final boolean hasStatusMessage()
+	{
+		return m_statusMsg != null ? true : false;
+	}
+	
+	/**
+	 * Return the status message
+	 * 
+	 * @return String
+	 */
+	public final String getStatusMessage()
+	{
+		return m_statusMsg;
+	}
+	
+	/**
+	 * Return the status message property
+	 * 
+	 * @return String
+	 */
+	public String jsGet_message()
+	{
+		return m_statusMsg != null ? m_statusMsg : ""; 
+	}
+	
+	/**
+	 * Determine if there are optional response values
+	 * 
+	 * @return boolean
+	 */
+	public final boolean hasResponseValues()
+	{
+		return m_responseValues != null ? true : false;
+	}
+	
+	/**
+	 * Return the count of response values
+	 * 
+	 * @return int
+	 */
+	public final int numberOfResponseValues()
+	{
+		return m_responseValues != null ? m_responseValues.size() : 0;
+	}
+	
+	/**
+	 * Get the response value list
+	 * 
+	 * @return List<Object>
+	 */
+	public final List<Object> getResponseValues()
+	{
+		return m_responseValues;
+	}
+	
+	/**
+	 * Add a response value
+	 * 
+	 * @param respObj Object
+	 */
+	public final void addResponseValue(Object respObj)
+	{
+		if ( m_responseValues == null)
+			m_responseValues = new ArrayList<Object>();
+		
+		m_responseValues.add(respObj);
+	}
+
+	/**
+	 * Set the status code and message
+	 * 
+	 * @param sts int
+	 * @param msg String
+	 */
+	public final void setStatus(int sts, String msg)
+	{
+		m_status    = sts;
+		m_statusMsg = msg;
+	}
+	
+	/**
+	 * Set the status property
+	 * 
+	 * @param sts int
+	 */
+	public void jsSet_status(int sts)
+	{
+		m_status = sts;
+	}
+	
+	/**
+	 * Set the status message property
+	 * 
+	 * @param msg String
+	 */
+	public void jsSet_message(String msg)
+	{
+		m_statusMsg = msg;
+	}
+	
+	/**
+	 * Return the desktop response as a string
+	 * 
+	 * @return String
+	 */
+	public String toString()
+	{
+		StringBuilder str = new StringBuilder();
+		
+		str.append("[");
+		str.append(getStatus());
+		str.append(":");
+		if ( hasStatusMessage())
+			str.append(getStatusMessage());
+		else
+			str.append("<NoMsg>");
+		str.append(":Values=");
+		str.append(numberOfResponseValues());
+		str.append("]");
+		
+		return str.toString();
+	}
+}