RM-1099 (Refactor Transfer and Accession reports)

* Added a transfer node class to pass the properties of a transfer node to the freemarker template model

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

rm-server/config/alfresco/module/org_alfresco_module_rm/bootstrap/report/report_rmr_transferReport.html.ftl

@@ -48,11 +48,19 @@
       </table>
       <h2>${message("file.report.transferred.items")}</h2>
       <div class="transferred-item">
-         <#-- FIXME
+         <#list properties.transferNodes as transferNode>
-         <span class="nodeName">folder</span>&nbsp;(Unique Folder Identifier:&nbsp;2013-1385393610833)
+            <#if transferNode.folder>
-         <div class="records">
+               <span class="nodeName">
-         </div>
+                  ${transferNode.properties["name"]?html}
-         -->
+               </span>
+               (${message("file.report.unique.folder.identifier")}: ${transferNode.properties["identifier"]?html})
+               <div class="records">
+                  <#-- FIXME: Records -->
+               </div>
+            <#else>
+               <#-- FIXME: Records -->
+            </#if>
+         </#list>
       </div>
    </body>
 </html>

rm-server/config/alfresco/module/org_alfresco_module_rm/messages/template.properties

@@ -14,3 +14,4 @@ file.report.transferred.items=Transferred Items
 file.report.performed.by=Performed By
 file.report.record=Record
 file.report.record.folder=Record Folder
+file.report.unique.folder.identifier=Unique Folder Identifier

rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/report/action/TransferNode.java

@@ -0,0 +1,78 @@
+/*
+ * Copyright (C) 2005-2013 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.alfresco.module.org_alfresco_module_rm.report.action;
+
+import java.io.Serializable;
+import java.util.Map;
+
+import org.alfresco.service.cmr.repository.NodeRef;
+
+/**
+ * Transfer node class
+ *
+ * @author Tuna Aksoy
+ * @since 2.2
+ */
+public class TransferNode
+{
+    /** Transfer node reference */
+    private NodeRef nodeRef;
+
+    /** Transfer node type */
+    private boolean folder;
+
+    /** Transfer node properties */
+    private Map<String, Serializable> properties;
+
+    /**
+     * @param nodeRef
+     * @param folder
+     * @param properties
+     */
+    public TransferNode(NodeRef nodeRef, boolean folder, Map<String, Serializable> properties)
+    {
+        this.nodeRef = nodeRef;
+        this.folder = folder;
+        this.properties = properties;
+    }
+
+    /**
+     * @return transfer node reference
+     */
+    public NodeRef getNodeRef()
+    {
+        return this.nodeRef;
+    }
+
+    /**
+     * @return transfer node type
+     */
+    public boolean isFolder()
+    {
+        return this.folder;
+    }
+
+    /**
+     * @return transfer node properties
+     */
+    public Map<String, Serializable> getProperties()
+    {
+        return this.properties;
+    }
+}

rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/report/action/TransferReportAction.java

@@ -19,14 +19,17 @@
 package org.alfresco.module.org_alfresco_module_rm.report.action;
 
 import java.io.Serializable;
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
+import org.alfresco.model.ContentModel;
 import org.alfresco.module.org_alfresco_module_rm.disposition.DispositionSchedule;
 import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel;
 import org.alfresco.service.cmr.repository.ChildAssociationRef;
 import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.namespace.QName;
 import org.alfresco.service.namespace.RegexQNamePattern;
 import org.apache.commons.lang.StringUtils;
 
@@ -42,51 +45,77 @@ public class TransferReportAction extends BaseReportAction
     protected Map<String, Serializable> addProperties(NodeRef nodeRef)
     {
         // Get all 'transferred' nodes
-        NodeRef[] transferNodes = getTransferNodes(nodeRef);
+        List<TransferNode> transferNodes = getTransferNodes(nodeRef);
 
         // Get the disposition authority
         String dispositionAuthority = getDispositionAuthority(transferNodes);
 
         // Save to the properties map
         Map<String, Serializable> properties = new HashMap<String, Serializable>(2);
-        properties.put("transferNodes", transferNodes);
+        properties.put("transferNodes", (ArrayList<TransferNode>) transferNodes);
         properties.put("dispositionAuthority", dispositionAuthority);
 
         return properties;
     }
 
     /**
-     * Returns an array of NodeRefs representing the items to be transferred.
+     * Returns a list of transfer nodes
      *
-     * @param transferNode The transfer object
+     * @param nodeRef The transfer object
-     * @return Array of NodeRefs
+     * @return Transfer node list
      */
-    private NodeRef[] getTransferNodes(NodeRef transferNode)
+    private List<TransferNode> getTransferNodes(NodeRef nodeRef)
     {
-        List<ChildAssociationRef> assocs = this.nodeService.getChildAssocs(transferNode,
+        List<ChildAssociationRef> assocs = nodeService.getChildAssocs(nodeRef, RecordsManagementModel.ASSOC_TRANSFERRED, RegexQNamePattern.MATCH_ALL);
-                    RecordsManagementModel.ASSOC_TRANSFERRED, RegexQNamePattern.MATCH_ALL);
+        List<TransferNode> transferNodes = new ArrayList<TransferNode>(assocs.size());
-        NodeRef[] itemsToTransfer = new NodeRef[assocs.size()];
+        for (ChildAssociationRef assoc : assocs)
-        for (int idx = 0; idx < assocs.size(); idx++)
         {
-            itemsToTransfer[idx] = assocs.get(idx).getChildRef();
+            NodeRef childRef = assoc.getChildRef();
+            boolean isFolder = dictionaryService.isSubClass(nodeService.getType(childRef), ContentModel.TYPE_FOLDER);
+            Map<String, Serializable> properties = getTransferNodeProperties(childRef, isFolder);
+            transferNodes.add(new TransferNode(childRef, isFolder, properties));
         }
-        return itemsToTransfer;
+        return transferNodes;
     }
 
     /**
-     * Gets the disposition authority from the array of the transfer objects
+     * Helper method to get the properties of a transfer node
      *
-     * @param itemsToTransfer   The transfer objects
+     * @param childRef  Node reference
-     * @return  Disposition authority
+     * @param isFolder  Type of the transfer node
+     * @return Transfer node properties
      */
-    private String getDispositionAuthority(NodeRef[] itemsToTransfer)
+    private Map<String, Serializable> getTransferNodeProperties(NodeRef childRef, boolean isFolder)
+    {
+        Map<String, Serializable> transferNodeProperties = new HashMap<String, Serializable>(2);
+        if (isFolder)
+        {
+            Map<QName, Serializable> properties = nodeService.getProperties(childRef);
+            transferNodeProperties.put("name", properties.get(ContentModel.PROP_NAME));
+            transferNodeProperties.put("identifier", properties.get(RecordsManagementModel.PROP_IDENTIFIER));
+        }
+        else
+        {
+            // FIXME: Record
+        }
+        return transferNodeProperties;
+    }
+
+    /**
+     * Gets the disposition authority from the list of the transfer nodes
+     *
+     * @param transferNodes   The transfer nodes
+     * @return Disposition authority
+     */
+    private String getDispositionAuthority(List<TransferNode> transferNodes)
     {
         // use RMService to get disposition authority
         String dispositionAuthority = null;
-        if (itemsToTransfer.length > 0)
+        if (transferNodes.size() > 0)
         {
             // use the first transfer item to get to disposition schedule
-            DispositionSchedule ds = dispositionService.getDispositionSchedule(itemsToTransfer[0]);
+            NodeRef nodeRef = transferNodes.iterator().next().getNodeRef();
+            DispositionSchedule ds = dispositionService.getDispositionSchedule(nodeRef);
             if (ds != null)
             {
                 dispositionAuthority = ds.getDispositionAuthority();