. Workflow Command Servlet implementation

. Refactored common simple workflow code into a util class.
. Example template that demonstrates both querying for workflow information on a document (useful anyway) and executes the servlet to perform both the Approve and Reject actions if appropriate for the document.
. TemplateNode template API object now exposes the browse navigation servlet URL for a Space as the "url" API call
. Fix long standing bug in UIRichList (since PR1!) - subtle behaviour issue where under very high server loads, the richlist component would render the wrong number of items per row.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2590 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Kevin Roast
2006-03-30 14:09:08 +00:00
parent 9c9a0d3d1b
commit a9e9e57b6d
9 changed files with 613 additions and 92 deletions

View File

@@ -0,0 +1,149 @@
/*
* Copyright (C) 2005 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.web.bean;
import java.util.Map;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.model.ContentModel;
import org.alfresco.service.cmr.repository.CopyService;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.alfresco.web.bean.repository.Node;
import org.apache.log4j.Logger;
/**
* Helper class for common Simple Workflow functionality.
* <p>
* This class should be replaced with calls to a WorkflowService once it is available.
*
* @author Kevin Roast
*/
public class WorkflowUtil
{
private static Logger logger = Logger.getLogger(WorkflowUtil.class);
/**
* Execute the Approve step for the Simple Workflow on a node.
*
* @param ref NodeRef to the node with the workflow
* @param nodeService NodeService instance
* @param copyService CopyService instance
*
* @throws AlfrescoRuntimeException
*/
public static void approve(NodeRef ref, NodeService nodeService, CopyService copyService)
throws AlfrescoRuntimeException
{
Node docNode = new Node(ref);
if (docNode.hasAspect(ContentModel.ASPECT_SIMPLE_WORKFLOW) == false)
{
throw new AlfrescoRuntimeException("Cannot approve a document that is not part of a workflow.");
}
// get the simple workflow aspect properties
Map<String, Object> props = docNode.getProperties();
Boolean approveMove = (Boolean)props.get(ContentModel.PROP_APPROVE_MOVE.toString());
NodeRef approveFolder = (NodeRef)props.get(ContentModel.PROP_APPROVE_FOLDER.toString());
// first we need to take off the simpleworkflow aspect
nodeService.removeAspect(ref, ContentModel.ASPECT_SIMPLE_WORKFLOW);
if (approveMove.booleanValue())
{
// move the document to the specified folder
String qname = QName.createValidLocalName(docNode.getName());
nodeService.moveNode(ref, approveFolder, ContentModel.ASSOC_CONTAINS,
QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, qname));
}
else
{
// copy the document to the specified folder
String qname = QName.createValidLocalName(docNode.getName());
copyService.copy(ref, approveFolder, ContentModel.ASSOC_CONTAINS,
QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, qname));
}
if (logger.isDebugEnabled())
{
String movedCopied = approveMove ? "moved" : "copied";
logger.debug("Document has been approved and " + movedCopied + " to folder with id of " +
approveFolder.getId());
}
}
/**
* Execute the Reject step for the Simple Workflow on a node.
*
* @param ref NodeRef to the node with the workflow
* @param nodeService NodeService instance
* @param copyService CopyService instance
*
* @throws AlfrescoRuntimeException
*/
public static void reject(NodeRef ref, NodeService nodeService, CopyService copyService)
throws AlfrescoRuntimeException
{
Node docNode = new Node(ref);
if (docNode.hasAspect(ContentModel.ASPECT_SIMPLE_WORKFLOW) == false)
{
throw new AlfrescoRuntimeException("Cannot reject a document that is not part of a workflow.");
}
// get the simple workflow aspect properties
Map<String, Object> props = docNode.getProperties();
String rejectStep = (String)props.get(ContentModel.PROP_REJECT_STEP.toString());
Boolean rejectMove = (Boolean)props.get(ContentModel.PROP_REJECT_MOVE.toString());
NodeRef rejectFolder = (NodeRef)props.get(ContentModel.PROP_REJECT_FOLDER.toString());
if (rejectStep == null && rejectMove == null && rejectFolder == null)
{
throw new AlfrescoRuntimeException("The workflow does not have a reject step defined,");
}
// first we need to take off the simpleworkflow aspect
nodeService.removeAspect(ref, ContentModel.ASPECT_SIMPLE_WORKFLOW);
if (rejectMove.booleanValue())
{
// move the document to the specified folder
String qname = QName.createValidLocalName(docNode.getName());
nodeService.moveNode(ref, rejectFolder, ContentModel.ASSOC_CONTAINS,
QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, qname));
}
else
{
// copy the document to the specified folder
String qname = QName.createValidLocalName(docNode.getName());
copyService.copy(ref, rejectFolder, ContentModel.ASSOC_CONTAINS,
QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, qname));
}
if (logger.isDebugEnabled())
{
String movedCopied = rejectMove ? "moved" : "copied";
logger.debug("Document has been rejected and " + movedCopied + " to folder with id of " +
rejectFolder.getId());
}
}
}