ResumeStep.java

/*
 * ResumeStep.java
 *
 * Version: $Revision: 3705 $
 *
 * Date: $Date: 2009-04-11 18:02:24 +0100 (Sat, 11 Apr 2009) $
 *
 * Copyright (c) 2002, Hewlett-Packard Company and Massachusetts
 * Institute of Technology.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * - Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * - Neither the name of the Hewlett-Packard Company nor the name of the
 * Massachusetts Institute of Technology nor the names of their
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */
package org.dspace.app.xmlui.aspect.submission.submit;

import java.io.IOException;
import java.sql.SQLException;

import org.apache.cocoon.environment.ObjectModelHelper;
import org.apache.cocoon.environment.Request;
import org.dspace.app.xmlui.utils.UIException;
import org.dspace.app.xmlui.aspect.submission.AbstractStep;
import org.dspace.app.xmlui.wing.Message;
import org.dspace.app.xmlui.wing.WingException;
import org.dspace.app.xmlui.wing.element.Body;
import org.dspace.app.xmlui.wing.element.Division;
import org.dspace.app.xmlui.wing.element.ReferenceSet;
import org.dspace.app.xmlui.wing.element.List;
import org.dspace.authorize.AuthorizeException;
import org.dspace.content.Collection;
import org.dspace.content.Item;
import org.xml.sax.SAXException;

import uk.ac.jorum.licence.LicenceController;

/**
 * This step is used when the a user clicks an unfinished submission 
 * from the submissions page. Here we present the full item and then 
 * give the user the option to resume the item's submission.
 * <P>
 * This is not a true "step" in the submission process, it just
 * kicks off editing an unfinished submission.
 * 
 * FIXME: We should probably give the user the option to remove the 
 * submission as well.
 * 
 * @author Scott Phillips
 * @author Tim Donohue (small updates for Configurable Submission)
 */
public class ResumeStep extends AbstractStep
{
	/** Language Strings **/
    protected static final Message T_submit_resume = 
        message("xmlui.Submission.submit.ResumeStep.submit_resume");
    protected static final Message T_submit_cancel = 
        message("xmlui.general.cancel");
  
	/**
	 * Establish our required parameters, abstractStep will enforce these.
	 */
	public ResumeStep()
	{
		this.requireWorkspace = true;
	}


	public void addBody(Body body) throws SAXException, WingException,
	UIException, SQLException, IOException, AuthorizeException
	{
		// Get any metadata that may be removed by unselecting one of these options.
		Item item = submission.getItem();
		Collection collection = submission.getCollection();
		String actionURL = contextPath + "/handle/"+collection.getHandle() + "/submit/" + knot.getId() + ".continue";

		Request request = ObjectModelHelper.getRequest(objectModel);
		String showfull = request.getParameter("showfull");

		// if the user selected showsimple, remove showfull.
		if (showfull != null && request.getParameter("showsimple") != null)
			showfull = null;

		Division div = body.addInteractiveDivision("resume-submission", actionURL, Division.METHOD_POST, "primary submission");
		div.setHead(T_submission_head);

		
		// START CG - 07/10/09 So we can view CC licence and icon in Edit Item>View Item 
        //Adds cc licence name and location of appropriate cc licence icon to the dri
        Division ccLicence = div.addDivision("cc_licence_div");
        ccLicence.addHidden("cc_licence_name").setValue(LicenceController.getLicenseName(item));
        ccLicence.addHidden("cc_licence_icon_location").setValue((LicenceController.getLicenseIconLocation(item)));
        // END CG - 06/10/09 
		

		if (showfull == null)
		{
			ReferenceSet referenceSet = div.addReferenceSet("submission",ReferenceSet.TYPE_SUMMARY_VIEW);
			referenceSet.addReference(item);
//			div.addPara().addButton("showfull").setValue(T_showfull);
		} 
		else
		{
			ReferenceSet referenceSet = div.addReferenceSet("submission",ReferenceSet.TYPE_DETAIL_VIEW);
			referenceSet.addReference(item);
			div.addPara().addButton("showsimple").setValue(T_showsimple);

			div.addHidden("showfull").setValue("true");
		}


		List form = div.addList("resume-submission",List.TYPE_FORM);

		org.dspace.app.xmlui.wing.element.Item actions = form.addItem();
		actions.addButton("submit_resume").setValue(T_submit_resume);
		actions.addButton("submit_cancel").setValue(T_submit_cancel);
	}
}