Removed unused code, reorganized code, documentation added.

git-svn-id: https://svn.libreccm.org/ccm/trunk@2067 8810af33-2d31-482b-a856-94f89814c4df

ccm-portalworkspace/doc/unsupported/ui-generic/DefaultWorkspace.java

@@ -16,8 +16,9 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  */
 
-package com.arsdigita.portalworkspace.ui.jsp;
+package com.arsdigita.portalworkspace.ui.personal;
 
+import com.arsdigita.portalworkspace.ui.DefaultWorkspaceSelectionModel;
 import com.arsdigita.bebop.PageState;
 import com.arsdigita.bebop.event.ActionEvent;
 import com.arsdigita.bebop.event.ActionListener;
@@ -42,6 +43,18 @@ import org.apache.log4j.Logger;
 
 
 
+// Intended usage undocumented, class actually not referenced by any code.
+// Probably an experimental alternativ implementation to create a portal page
+// based on / derived from WorkspaceComponent (which in turn derived from 
+// SimpleComponent).
+// Altermnative to WorkspaceEditor / WorkspaceViewer, derived from 
+// class AbstractWorkspaceComponent (which in turn derived form SimpleComponent
+// as well).
+// Seems to use the same WorkspaceSelectionModel process to fetch the actual
+// instance to serve.
+
+
+
 /**
  * Another specific entry point into a portal workspace page, here based
  * upon WorkspaceComponent (as an alternative to be based on 

ccm-portalworkspace/doc/unsupported/ui-generic/PackageWorkspace.java

@@ -16,7 +16,7 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  */
 
-package com.arsdigita.portalworkspace.ui.jsp;
+package com.arsdigita.portalworkspace.ui.personal;
 
 import com.arsdigita.bebop.Component;
 import com.arsdigita.bebop.Container;
@@ -34,12 +34,25 @@ import com.arsdigita.toolbox.ui.SecurityContainer;
 import com.arsdigita.web.LoginSignal;
 
 
+
+// Intended usage undocumented, class actually not referenced by any code.
+// Probably an experimental alternativ implementation to create a portal page
+// based on / derived from WorkspaceComponent (which in turn derived from 
+// SimpleComponent).
+// Altermnative to WorkspaceEditor / WorkspaceViewer, derived from 
+// class AbstractWorkspaceComponent (which in turn derived form SimpleComponent
+// as well).
+// Seems to use the same WorkspaceSelectionModel process to fetch the actual
+// instance to serve.
+
+
+
 /**
  * Another specific entry point into a portal workspace page, here based upon
  * WorkspaceComponent (as an alternative to AbstractWorkspaceComponent.
  */
 // As of APLAWS 1.0.4 / CCM 6.6.x this class may never have been used and is
-// propably unfinished work or undinished port from ccm-portalserver module.
+// propably unfinished work or unfinished port from ccm-portalserver module.
 // As with WorkspaceViewer it should be invoked  by a jsp. It is not directly
 // used by any java code.
 public class PackageWorkspace extends WorkspaceComponent {
@@ -47,7 +60,7 @@ public class PackageWorkspace extends WorkspaceComponent {
     private RequestLocal m_isAdmin = new RequestLocal();
     
     /**
-     * 
+     * Constructor. 
      */
     public PackageWorkspace() {
         super(new PackageWorkspaceSelectionModel());
@@ -59,6 +72,7 @@ public class PackageWorkspace extends WorkspaceComponent {
      * @param parent
      * @param child
      */
+    @Override
     protected void addCustomizeLinks(Container parent, Component child) {
         Container secure = new WorkspaceSecurityContainer(child);
         super.addCustomizeLinks(parent, secure);

ccm-portalworkspace/doc/unsupported/ui-generic/UserWorkspace.java

@@ -16,10 +16,24 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  */
 
-package com.arsdigita.portalworkspace.ui.personalws;
+package com.arsdigita.portalworkspace.ui.personal;
 
 import com.arsdigita.portalworkspace.ui.WorkspaceComponent;
 
+
+
+// Intended usage undocumented, class actually not referenced by any code.
+// Probably an experimental alternativ implementation to create a portal page
+// based on / derived from WorkspaceComponent (which in turn derived from 
+// SimpleComponent).
+// Altermnative to WorkspaceEditor / WorkspaceViewer, derived from 
+// class AbstractWorkspaceComponent (which in turn derived form SimpleComponent
+// as well).
+// Seems to use the same WorkspaceSelectionModel process to fetch the actual
+// instance to serve.
+
+
+
 /**
  * Another specific entry point into a portal workspace page, here based upon
  * WorkspaceComponent (as an alternative to AbstractWorkspaceComponent.

ccm-portalworkspace/doc/unsupported/ui-generic/WorkspaceComponent.java

@@ -43,6 +43,15 @@ import com.arsdigita.web.RedirectSignal;
 import com.arsdigita.web.URL;
 import com.arsdigita.xml.Element;
 
+
+
+// Intended usage undocumented. Seems to be an experiomental alternativ to
+// AbstractWorkspaceComponent (which is derived from SimpleContainer as well)
+// as a parent class to classses which create protal pages.
+// Nevertheless: Wild guess!
+
+
+
 /**
  * Purpose?.
  * 

ccm-portalworkspace/src/com/arsdigita/portalworkspace/StatefulPersistentPortal.java

@@ -34,7 +34,7 @@ import com.arsdigita.bebop.portal.PortalModelBuilder;
 import com.arsdigita.bebop.portal.PortletRenderer;
 import com.arsdigita.portalworkspace.ui.PortalSelectionModel;
 import com.arsdigita.portalworkspace.ui.PortletSelectionModel;
-import com.arsdigita.portalworkspace.ui.WorkspaceSelectionModel;
+import com.arsdigita.portalworkspace.ui.WorkspaceSelectionAbstractModel;
 import com.arsdigita.persistence.DataQuery;
 import com.arsdigita.persistence.SessionManager;
 import com.arsdigita.portal.PortletType;
@@ -58,7 +58,7 @@ public class StatefulPersistentPortal extends SimpleContainer {
     private static final Logger s_log =
                                 Logger.getLogger(StatefulPersistentPortal.class);
 
-    // private WorkspaceSelectionModel m_workspace;
+    // private WorkspaceSelectionAbstractModel m_workspace;
     // private PortletSelectionModel m_portlet;
     private PortalModelBuilder m_portalModelBuilder;
     private PortalSelectionModel m_portal;

ccm-portalworkspace/src/com/arsdigita/portalworkspace/Workspace.java

@@ -34,7 +34,7 @@ import com.arsdigita.kernel.permissions.PermissionDescriptor;
 import com.arsdigita.kernel.permissions.PermissionManager;
 import com.arsdigita.kernel.permissions.PermissionService;
 import com.arsdigita.kernel.permissions.PrivilegeDescriptor;
-import com.arsdigita.portalworkspace.ui.personalws.PersonalPortalPage;
+import com.arsdigita.portalworkspace.ui.personal.PersonalPortalPage;
 import com.arsdigita.persistence.DataAssociation;
 import com.arsdigita.persistence.DataAssociationCursor;
 import com.arsdigita.persistence.DataCollection;

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/AbstractWorkspaceComponent.java

@@ -31,7 +31,7 @@ import com.arsdigita.portalworkspace.WorkspacePage;
  */
 public abstract class AbstractWorkspaceComponent extends SimpleContainer {
 
-    private WorkspaceSelectionModel m_workspace;
+    private WorkspaceSelectionAbstractModel m_workspace;
 
     private DefaultPortalSelectionModel m_portal;
 
@@ -54,7 +54,7 @@ public abstract class AbstractWorkspaceComponent extends SimpleContainer {
      * 
      * @param workspace
      */
-    public AbstractWorkspaceComponent(WorkspaceSelectionModel workspace) {
+    public AbstractWorkspaceComponent(WorkspaceSelectionAbstractModel workspace) {
 
         /* Creates a WorkspaceComponent (SimpleContainer) that will wrap its
          * children in the specified tag.                                     */
@@ -75,7 +75,7 @@ public abstract class AbstractWorkspaceComponent extends SimpleContainer {
     /**
      *
      */
-    public void setWorkspaceModel(WorkspaceSelectionModel workspace) {
+    public void setWorkspaceModel(WorkspaceSelectionAbstractModel workspace) {
         m_workspace = workspace;
         m_details.setWorkspaceModel(workspace);
         m_portalList.setWorkspaceModel(workspace);

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/CategoryPortalSelectionModel.java

@@ -35,7 +35,7 @@ import com.arsdigita.util.Assert;
  * the inclusion of a portal workspace as a leaf page into a navigation tree.
  * 
  */
-public class CategoryPortalSelectionModel extends WorkspaceSelectionModel {
+public class CategoryPortalSelectionModel extends WorkspaceSelectionAbstractModel {
 
     /**
      * 

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/DefaultPortalSelectionModel.java

@@ -36,7 +36,7 @@ import java.math.BigDecimal;
 public class DefaultPortalSelectionModel extends ACSObjectSelectionModel
 		                         implements PortalSelectionModel {
 
-    private WorkspaceSelectionModel m_workspace;
+    private WorkspaceSelectionAbstractModel m_workspace;
 
     /**
      *
@@ -46,7 +46,7 @@ public class DefaultPortalSelectionModel extends ACSObjectSelectionModel
         this(null, param);
     }
 
-    public DefaultPortalSelectionModel(WorkspaceSelectionModel workspace,
+    public DefaultPortalSelectionModel(WorkspaceSelectionAbstractModel workspace,
                                        BigDecimalParameter param) {
         super(WorkspacePage.class.getName(),
               WorkspacePage.BASE_DATA_OBJECT_TYPE, param);
@@ -58,7 +58,7 @@ public class DefaultPortalSelectionModel extends ACSObjectSelectionModel
      *
      * @param workspace
      */
-    public void setWorkspaceModel(WorkspaceSelectionModel workspace) {
+    public void setWorkspaceModel(WorkspaceSelectionAbstractModel workspace) {
         m_workspace = workspace;
     }
 

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/LayoutForm.java

@@ -55,7 +55,7 @@ import com.arsdigita.util.UncheckedWrapperException;
 public class LayoutForm extends Form implements FormProcessListener,
 		FormInitListener {
 
-	private WorkspaceSelectionModel m_workspace;
+	private WorkspaceSelectionAbstractModel m_workspace;
 
 	private PortalSelectionModel m_portal;
 
@@ -67,7 +67,7 @@ public class LayoutForm extends Form implements FormProcessListener,
 		this(null, portal);
 	}
 
-	public LayoutForm(WorkspaceSelectionModel workspace,
+	public LayoutForm(WorkspaceSelectionAbstractModel workspace,
 			PortalSelectionModel portal) {
 		super("editLayout", new SimpleContainer("portal:editLayout",
 				WorkspacePage.PORTAL_XML_NS));
@@ -104,7 +104,7 @@ public class LayoutForm extends Form implements FormProcessListener,
 		addInitListener(this);
 	}
 
-	public void setWorkspaceModel(WorkspaceSelectionModel workspace) {
+	public void setWorkspaceModel(WorkspaceSelectionAbstractModel workspace) {
 		m_workspace = workspace;
 	}
 

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/PersistentPortal.java

@@ -94,7 +94,7 @@ public class PersistentPortal extends SimpleContainer {
 
     public static final String ACTION_DELETE = "delete";
 
-    private WorkspaceSelectionModel m_workspace;
+    private WorkspaceSelectionAbstractModel m_workspace;
     private PortalSelectionModel m_portal;
     private PortletTypeSelectionModel m_portletType;
     private PortletSelectionModel m_portlet;

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/PortalEditForm.java

@@ -47,7 +47,7 @@ import com.arsdigita.util.Assert;
 public class PortalEditForm extends Form implements FormProcessListener,
 		FormInitListener {
 
-    private WorkspaceSelectionModel m_workspace;
+    private WorkspaceSelectionAbstractModel m_workspace;
     private PortalSelectionModel m_portal;
     private TextField m_title;
     private Submit m_save;
@@ -67,7 +67,7 @@ public class PortalEditForm extends Form implements FormProcessListener,
      * @param workspace
      * @param portal
      */
-    public PortalEditForm(WorkspaceSelectionModel workspace,
+    public PortalEditForm(WorkspaceSelectionAbstractModel workspace,
                           PortalSelectionModel portal) {
 
         super("editPortal", new SimpleContainer("portal:editPortal",
@@ -93,7 +93,7 @@ public class PortalEditForm extends Form implements FormProcessListener,
      *
      * @param workspace
      */
-    public void setWorkspaceModel(WorkspaceSelectionModel workspace) {
+    public void setWorkspaceModel(WorkspaceSelectionAbstractModel workspace) {
         m_workspace = workspace;
     }
 

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/PortalList.java

@@ -41,7 +41,7 @@ import com.arsdigita.xml.XML;
  */
 public abstract class PortalList extends SimpleContainer {
 
-    private WorkspaceSelectionModel m_workspace;
+    private WorkspaceSelectionAbstractModel m_workspace;
     private PortalSelectionModel m_portal;
 
     private Map m_actions = new HashMap();
@@ -61,7 +61,7 @@ public abstract class PortalList extends SimpleContainer {
      * @param workspace
      * @param portal
      */
-    public PortalList(WorkspaceSelectionModel workspace,
+    public PortalList(WorkspaceSelectionAbstractModel workspace,
                       PortalSelectionModel portal) {
         super("portal:portalList", WorkspacePage.PORTAL_XML_NS);
 
@@ -69,7 +69,7 @@ public abstract class PortalList extends SimpleContainer {
         m_portal = portal;
     }
 
-    public void setWorkspaceModel(WorkspaceSelectionModel workspace) {
+    public void setWorkspaceModel(WorkspaceSelectionAbstractModel workspace) {
         m_workspace = workspace;
     }
 

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/PortalListEditor.java

@@ -42,7 +42,7 @@ public class PortalListEditor extends PortalListViewer {
 		this(null, portal);
 	}
 
-	public PortalListEditor(WorkspaceSelectionModel workspace,
+	public PortalListEditor(WorkspaceSelectionAbstractModel workspace,
 			PortalSelectionModel portal) {
 		super(workspace, portal);
 
@@ -118,7 +118,7 @@ public class PortalListEditor extends PortalListViewer {
 		});
 	}
 
-	public void setWorkspaceModel(WorkspaceSelectionModel workspace) {
+	public void setWorkspaceModel(WorkspaceSelectionAbstractModel workspace) {
 		super.setWorkspaceModel(workspace);
 		m_edit.setWorkspaceModel(workspace);
 		m_layout.setWorkspaceModel(workspace);

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/PortalListViewer.java

@@ -47,7 +47,7 @@ public class PortalListViewer extends PortalList {
         this(null, portal);
     }
 
-    public PortalListViewer(WorkspaceSelectionModel workspace,
+    public PortalListViewer(WorkspaceSelectionAbstractModel workspace,
                             PortalSelectionModel portal) {
 
         super(workspace, portal);

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/WorkspaceDetails.java

@@ -37,13 +37,13 @@ import com.arsdigita.xml.XML;
  */
 public class WorkspaceDetails extends SimpleComponent {
 
-	private WorkspaceSelectionModel m_workspace;
+	private WorkspaceSelectionAbstractModel m_workspace;
 
-	public WorkspaceDetails(WorkspaceSelectionModel workspace) {
+	public WorkspaceDetails(WorkspaceSelectionAbstractModel workspace) {
 		m_workspace = workspace;
 	}
 
-	public void setWorkspaceModel(WorkspaceSelectionModel workspace) {
+	public void setWorkspaceModel(WorkspaceSelectionAbstractModel workspace) {
 		m_workspace = workspace;
 	}
 

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/WorkspaceEditor.java

@@ -16,9 +16,8 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  */
 
-package com.arsdigita.portalworkspace.ui.jsp;
+package com.arsdigita.portalworkspace.ui;
 
-import com.arsdigita.portalworkspace.ui.WorkspaceSelectionModel;
 import com.arsdigita.bebop.ActionLink;
 import com.arsdigita.bebop.Form;
 import com.arsdigita.bebop.FormProcessException;
@@ -39,21 +38,15 @@ import com.arsdigita.kernel.Kernel;
 import com.arsdigita.kernel.Party;
 import com.arsdigita.portalworkspace.Workspace;
 import com.arsdigita.portalworkspace.WorkspacePage;
-import com.arsdigita.portalworkspace.ui.AbstractWorkspaceComponent;
-import com.arsdigita.portalworkspace.ui.PersistentPortal;
-import com.arsdigita.portalworkspace.ui.PortalHelper;
-import com.arsdigita.portalworkspace.ui.PortalList;
-import com.arsdigita.portalworkspace.ui.PortalListEditor;
-import com.arsdigita.portalworkspace.ui.PortalSelectionModel;
 import com.arsdigita.portalworkspace.util.GlobalizationUtil;
 
 import org.apache.log4j.Logger;
 
 
 /**
- * Another entry point into a standard portal workspace page where the
+ * Entry point into a standard (public or access restricted) portal workspace 
- * page is constructed in "edit" mode to allow configuration and 
+ * page where the page is constructed in "edit" mode to allow configuration 
- * modification by an authorized participant.
+ * and modification by an authorized participant.
  *
  * It is used via a jsp page which is invoked at the applications url.
  *
@@ -95,7 +88,7 @@ public class WorkspaceEditor extends AbstractWorkspaceComponent {
      * 
      * @param workspace
      */
-    public WorkspaceEditor(WorkspaceSelectionModel workspace) {
+    public WorkspaceEditor(WorkspaceSelectionAbstractModel workspace) {
 
         super(workspace);
         s_log.debug("WorkspaceEditor constructed");

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/WorkspaceSelectionAbstractModel.java

@@ -24,10 +24,15 @@ import com.arsdigita.bebop.RequestLocal;
 import com.arsdigita.portalworkspace.Workspace;
 
 /**
+ * Basic methods to select a workspace (portal application type instance) 
+ * to either display in view mode (eg using WorkspaceViewer class) or in 
+ * edit mode (eg using WorkspaceEdit class). 
  * 
- * 
+ * Child classes are specifically required to overwrite the abstract method 
+ * getDefaultWorkspace and adapt the selection procedure to specific 
+ * application / usage requirements.
  */
-public abstract class WorkspaceSelectionModel {
+public abstract class WorkspaceSelectionAbstractModel {
 
     /** Workspace. Bound to the current HTTP request. */
     private RequestLocal m_workspace;
@@ -35,7 +40,7 @@ public abstract class WorkspaceSelectionModel {
     /**
      * Constructor.
      */
-    public WorkspaceSelectionModel() {
+    public WorkspaceSelectionAbstractModel() {
         m_workspace = new RequestLocal() {
             @Override
             public Object initialValue(PageState state) {

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/WorkspaceSelectionDefaultModel.java

@@ -16,9 +16,8 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  */
 
-package com.arsdigita.portalworkspace.ui.jsp;
+package com.arsdigita.portalworkspace.ui;
 
-import com.arsdigita.portalworkspace.ui.WorkspaceSelectionModel;
 import com.arsdigita.bebop.PageState;
 import com.arsdigita.domain.DataObjectNotFoundException;
 import com.arsdigita.kernel.Kernel;
@@ -26,11 +25,19 @@ import com.arsdigita.kernel.Party;
 import com.arsdigita.portalworkspace.Workspace;
 
 /** 
+ * Default Implementation of abstract class WorkspaceSelectionAbstractModel which
+ * provides a default implementation of the (abstract) getDefaultWorkspace
+ * method.
+ * 
+ * This Implementation checks whether a user workspace has to be served and
+ * otherwise returns a default workspace.
+ * 
+ * Used by the the portal workspace JSP's (access path specified in web.xml)
+ * used to construct a workspace in either view (index.jsp) or edit (edit.jsp)
+ * mode
  * 
- * Used by the jsp, specified in web.xml and used to construct a personal
- * homepage for an loggedIn user
  */
-public class DefaultWorkspaceSelectionModel extends WorkspaceSelectionModel {
+public class WorkspaceSelectionDefaultModel extends WorkspaceSelectionAbstractModel {
 
     /**
      *

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/WorkspaceSelectionPackageModel.java

@@ -16,18 +16,33 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  *
  */
-package com.arsdigita.portalworkspace.ui.jsp;
+package com.arsdigita.portalworkspace.ui;
 
-import com.arsdigita.portalworkspace.ui.WorkspaceSelectionModel;
+import com.arsdigita.portalworkspace.ui.WorkspaceSelectionAbstractModel;
 import com.arsdigita.bebop.PageState;
 import com.arsdigita.kernel.Kernel;
 import com.arsdigita.portalworkspace.Workspace;
 
+
 /**
+ * Intended usage undocumented.
  * 
+ * Seems to provides a lighter version if WorkspaceSelectionDefaultModel
+ * which takes not into account whether to jump to a personal workspace 
+ * or not.
+ * 
+ * In order to makle use of it the portalworkspace JSP must be modified, 
+ * selecting this WorkspaceSelectionModel, eg.
+ * 
+ * instead of:
+ *     ((AbstractWorkspaceComponent)edit).setWorkspaceModel(
+ *                                       new WorkspaceSelectionDefaultModel());
+ * use
+ *     ((AbstractWorkspaceComponent)edit).setWorkspaceModel(
+ *                                       new WorkspaceSelectionPackageModel());
  * 
  */
-public class PackageWorkspaceSelectionModel extends WorkspaceSelectionModel {
+public class WorkspaceSelectionPackageModel extends WorkspaceSelectionAbstractModel {
 
     /**
      * 

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/WorkspaceSelectionUserModel.java

@@ -13,9 +13,9 @@
  *
  */
 
-package com.arsdigita.portalworkspace.ui.personalws;
+package com.arsdigita.portalworkspace.ui;
 
-import com.arsdigita.portalworkspace.ui.WorkspaceSelectionModel;
+import com.arsdigita.portalworkspace.ui.WorkspaceSelectionAbstractModel;
 import com.arsdigita.bebop.PageState;
 import com.arsdigita.domain.DataObjectNotFoundException;
 import com.arsdigita.kernel.Kernel;
@@ -24,10 +24,29 @@ import com.arsdigita.portalworkspace.Workspace;
 import com.arsdigita.util.UncheckedWrapperException;
 import com.arsdigita.web.LoginSignal;
 
-public class UserWorkspaceSelectionModel extends WorkspaceSelectionModel {
+
+/**
+ * Intended usage undocumented.
+ * 
+ * Seems to provides a lighter version if WorkspaceSelectionDefaultModel
+ * which requires a user logged-in and a user specific workspace. 
+ * Probably useful for non-public sites.
+ * 
+ * In order to makle use of it the portalworkspace JSP must be modified, 
+ * selecting this WorkspaceSelectionModel, eg.
+ * 
+ * instead of:
+ *     ((AbstractWorkspaceComponent)edit).setWorkspaceModel(
+ *                                       new WorkspaceSelectionDefaultModel());
+ * use
+ *     ((AbstractWorkspaceComponent)edit).setWorkspaceModel(
+ *                                       new WorkspaceSelectionUserModel());
+ * 
+ */
+public class WorkspaceSelectionUserModel extends WorkspaceSelectionAbstractModel {
 
     /**
-     *
+     * 
      * @param state
      * @return
      */

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/WorkspaceViewer.java

@@ -16,19 +16,15 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  */
 
-package com.arsdigita.portalworkspace.ui.jsp;
+package com.arsdigita.portalworkspace.ui;
 
 import com.arsdigita.portalworkspace.WorkspacePage;
-import com.arsdigita.portalworkspace.ui.WorkspaceSelectionModel;
+
-import com.arsdigita.portalworkspace.ui.AbstractWorkspaceComponent;
-import com.arsdigita.portalworkspace.ui.PersistentPortal;
-import com.arsdigita.portalworkspace.ui.PortalList;
-import com.arsdigita.portalworkspace.ui.PortalListViewer;
-import com.arsdigita.portalworkspace.ui.PortalSelectionModel;
 
 /**
- * Main (default) entry point into a standard portal workspace page where the
+ * Main (default) entry point into a standard (public or access restricted) 
- * page is constructed in "view" mode to present information to a visitor.
+ * portal workspace page where the page is constructed in "view" mode to 
+ * present information to a visitor.
  *
  * It is used via a jsp page which is invoked at the applications url.
  *
@@ -57,11 +53,11 @@ public class WorkspaceViewer extends AbstractWorkspaceComponent {
 
     /**
      * Constructor instantiates a WorkspaceViewer for a specific workspace
-     * object and sets the xml tags accordingly.
+     * object (instance) and sets the xml tags accordingly.
      *
      * @param workspace
      */
-    public WorkspaceViewer(WorkspaceSelectionModel workspace) {
+    public WorkspaceViewer(WorkspaceSelectionAbstractModel workspace) {
         super(workspace);
     }
 

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/admin/AdminPane.java

@@ -21,7 +21,7 @@ import com.arsdigita.bebop.SimpleContainer;
 import com.arsdigita.kernel.Group;
 import com.arsdigita.kernel.Kernel;
 import com.arsdigita.kernel.Role;
-import com.arsdigita.portalworkspace.ui.ApplicationSelectionModel;
+import com.arsdigita.portalworkspace.ui.sitemap.ApplicationSelectionModel;
 import com.arsdigita.portalworkspace.Workspace;
 import com.arsdigita.portalworkspace.WorkspacePage;
 

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/admin/CategoryComponent.java

@@ -18,7 +18,7 @@
 
 package com.arsdigita.portalworkspace.ui.admin;
 
-import com.arsdigita.portalworkspace.ui.ApplicationSelectionModel;
+import com.arsdigita.portalworkspace.ui.sitemap.ApplicationSelectionModel;
 import org.apache.log4j.Logger;
 
 import com.arsdigita.bebop.Label;

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/admin/CategoryTable.java

@@ -15,7 +15,7 @@
 
 package com.arsdigita.portalworkspace.ui.admin;
 
-import com.arsdigita.portalworkspace.ui.ApplicationSelectionModel;
+import com.arsdigita.portalworkspace.ui.sitemap.ApplicationSelectionModel;
 import java.math.BigDecimal;
 
 import org.apache.log4j.Logger;

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/admin/DeleteApplicationComponent.java

@@ -1,6 +1,6 @@
 package com.arsdigita.portalworkspace.ui.admin;
 
-import com.arsdigita.portalworkspace.ui.ApplicationSelectionModel;
+import com.arsdigita.portalworkspace.ui.sitemap.ApplicationSelectionModel;
 import org.apache.log4j.Logger;
 
 import com.arsdigita.bebop.ActionLink;

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/package.html

@@ -0,0 +1,46 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
+<html>
+<head>
+<title>Portal</title>
+</head>
+<body>
+
+<p>
+    Classes to compose the PortalWorkspaceuser interface for 
+    their  visitors .
+</p>
+
+<p>
+    The portal pages may be generally (publically) available or
+    restricted for registered and logged-in users and may or may
+    not require the user to be a member of a specific group. By
+    default the public user is sufficient who is automatically
+    member of the member group.
+</p>
+
+<p>
+    The user interface is accessed by a JSPs (in contrast to be
+    constructed by a servlet).
+</p>
+
+<p>
+    The class WorkspaceViewer is the jsp's entry point in view
+    mode for readers.
+</p>
+
+<p>
+    The class WorkspaceEditor is the jsp's entry point for users
+    permitted to style the portal page (add, delete, and modify
+    portlets).
+</p>
+
+<p>
+    Package <code>com/arsdigita/portalworkspace/ui/admin</code>
+    contains classes for additional administrative tasks (add and
+    remove members of access groups, associate a navigation
+    category, etc.).
+</p>
+
+
+</body>
+</html>

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/personal/PersonalPortalPage.java

@@ -16,7 +16,7 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  */
 
-package com.arsdigita.portalworkspace.ui.personalws;
+package com.arsdigita.portalworkspace.ui.personal;
 
 import com.arsdigita.bebop.Page;
 import com.arsdigita.bebop.event.RequestEvent;

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/sitemap/ApplicationDetails.java

@@ -22,7 +22,6 @@ import com.arsdigita.bebop.PageState;
 import com.arsdigita.bebop.SimpleContainer;
 import com.arsdigita.domain.DomainObjectXMLRenderer;
 import com.arsdigita.portalworkspace.WorkspacePage;
-import com.arsdigita.portalworkspace.ui.ApplicationSelectionModel;
 import com.arsdigita.web.Application;
 import com.arsdigita.xml.Element;
 

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/sitemap/ApplicationList.java

@@ -23,7 +23,6 @@ import com.arsdigita.bebop.SimpleContainer;
 import com.arsdigita.domain.DomainObjectFactory;
 import com.arsdigita.domain.DomainObjectXMLRenderer;
 import com.arsdigita.persistence.OID;
-import com.arsdigita.portalworkspace.ui.ApplicationSelectionModel;
 import com.arsdigita.portalworkspace.WorkspacePage;
 import com.arsdigita.util.UncheckedWrapperException;
 import com.arsdigita.web.Application;

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/sitemap/ApplicationPane.java

@@ -34,7 +34,6 @@ import com.arsdigita.kernel.Resource;
 import com.arsdigita.kernel.ui.ResourceConfigComponent;
 import com.arsdigita.persistence.OID;
 import com.arsdigita.portalworkspace.WorkspacePage;
-import com.arsdigita.portalworkspace.ui.ApplicationSelectionModel;
 import com.arsdigita.web.Application;
 import com.arsdigita.web.ApplicationType;
 import com.arsdigita.web.ApplicationTypeCollection;

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/sitemap/ApplicationSelectionModel.java

@@ -13,7 +13,7 @@
  *
  */
 
-package com.arsdigita.portalworkspace.ui;
+package com.arsdigita.portalworkspace.ui.sitemap;
 
 import org.apache.log4j.Logger;
 
@@ -26,21 +26,28 @@ import com.arsdigita.web.Application;
 import com.arsdigita.web.Web;
 
 /**
- * This selection model adds an (optional?) default value which will be 
+ * Selection model for applications, specifically used by portalworkspace
- * returned when nothing is selected.
+ * admin task to select an application instance to delete or to assign a 
+ * category.
+ * 
+ * This is a generic task as part of application management. A workspace is a 
+ * special case of this generic task. 
+ * 
+ * This selection model adds an (optional?) default value to the parent class 
+ * which will be returned when nothing is selected.
  * 
  * Used by packages admin and sitemap 
  */
 public class ApplicationSelectionModel extends ACSObjectSelectionModel {
 
-    public static final String DEFAULT_PARAM_NAME = "app_id";
-
-    private boolean m_hasDefaultValue;
-
     /** Creates a s_logging category with name = full name of class */
     private static final Logger s_log = Logger
                                     .getLogger(ApplicationSelectionModel.class);
 
+    public static final String DEFAULT_PARAM_NAME = "app_id";
+
+    private boolean m_hasDefaultValue;
+
     /**
      * Constructor 
      * 
@@ -48,10 +55,11 @@ public class ApplicationSelectionModel extends ACSObjectSelectionModel {
      * @param hasDefaultValue
      */
     public ApplicationSelectionModel(BigDecimalParameter param,
-                                     boolean hasDefaultValue) {
+                                       boolean hasDefaultValue) {
-        super(param);
 
+        super(param);
         m_hasDefaultValue = hasDefaultValue;
+
     }
 
     /**

ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/sitemap/SiteMapPane.java

@@ -18,7 +18,6 @@
 
 package com.arsdigita.portalworkspace.ui.sitemap;
 
-import com.arsdigita.portalworkspace.ui.ApplicationSelectionModel;
 import com.arsdigita.bebop.Page;
 import com.arsdigita.bebop.PageState;
 import com.arsdigita.bebop.SimpleContainer;

ccm-portalworkspace/web/templates/ccm-portalworkspace/admin/sitemap.jsp

@@ -17,7 +17,7 @@
          sitemapPage.addRequestListener(new ApplicationAuthenticationListener());
       </jsp:scriptlet>
       <define:component name="admin" 
-                    classname="com.arsdigita.portalworkspace.ui.admin.SiteMapPane" />
+                    classname="com.arsdigita.portalworkspace.ui.sitemap.SiteMapPane" />
     </define:page>
 
     <show:all/>

ccm-portalworkspace/web/templates/ccm-portalworkspace/edit.jsp

@@ -6,7 +6,7 @@
 
     <jsp:directive.page import="com.arsdigita.dispatcher.DispatcherHelper"/>
     <jsp:directive.page import="com.arsdigita.portalworkspace.ui.AbstractWorkspaceComponent"/>
-    <jsp:directive.page import="com.arsdigita.portalworkspace.ui.jsp.DefaultWorkspaceSelectionModel"/>
+    <jsp:directive.page import="com.arsdigita.portalworkspace.ui.DefaultWorkspaceSelectionModel"/>
 
     <jsp:scriptlet>
       DispatcherHelper.cacheDisable(response);
@@ -15,7 +15,7 @@
     <define:page name="editWorkspace" application="portal"
                  title="Workspace Customize" cache="true">
       <define:component name="edit"
-                   classname="com.arsdigita.portalworkspace.ui.jsp.WorkspaceEditor" />
+                   classname="com.arsdigita.portalworkspace.ui.WorkspaceEditor" />
       <jsp:scriptlet>
       ((AbstractWorkspaceComponent)edit).setWorkspaceModel(
                                              new DefaultWorkspaceSelectionModel());

ccm-portalworkspace/web/templates/ccm-portalworkspace/index.jsp

@@ -7,7 +7,7 @@
   <jsp:directive.page import="com.arsdigita.kernel.permissions.PrivilegeDescriptor"/>
   <jsp:directive.page import="com.arsdigita.portalworkspace.Workspace"/>
   <jsp:directive.page import="com.arsdigita.portalworkspace.ui.AbstractWorkspaceComponent"/>
-  <jsp:directive.page import="com.arsdigita.portalworkspace.ui.jsp.DefaultWorkspaceSelectionModel"/>
+  <jsp:directive.page import="com.arsdigita.portalworkspace.ui.DefaultWorkspaceSelectionModel"/>
   <jsp:directive.page import="com.arsdigita.toolbox.ui.ApplicationAuthenticationListener"/>
 
   <jsp:scriptlet>
@@ -24,7 +24,7 @@
     </jsp:scriptlet>
 
     <define:component name="view"
-                   classname="com.arsdigita.portalworkspace.ui.jsp.WorkspaceViewer" />
+                   classname="com.arsdigita.portalworkspace.ui.WorkspaceViewer" />
     <jsp:scriptlet>
       ((AbstractWorkspaceComponent) view).setWorkspaceModel(
                                           new DefaultWorkspaceSelectionModel());