01: /*
02: * AbstractSubmissionStep.java
03: *
04: * Version: $Revision: 1.3 $
05: *
06: * Date: $Date: 2006/07/13 23:20:54 $
07: *
08: * Copyright (c) 2002, Hewlett-Packard Company and Massachusetts
09: * Institute of Technology. All rights reserved.
10: *
11: * Redistribution and use in source and binary forms, with or without
12: * modification, are permitted provided that the following conditions are
13: * met:
14: *
15: * - Redistributions of source code must retain the above copyright
16: * notice, this list of conditions and the following disclaimer.
17: *
18: * - Redistributions in binary form must reproduce the above copyright
19: * notice, this list of conditions and the following disclaimer in the
20: * documentation and/or other materials provided with the distribution.
21: *
22: * - Neither the name of the Hewlett-Packard Company nor the name of the
23: * Massachusetts Institute of Technology nor the names of their
24: * contributors may be used to endorse or promote products derived from
25: * this software without specific prior written permission.
26: *
27: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28: * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31: * HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
32: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
33: * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
34: * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
35: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
36: * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
37: * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
38: * DAMAGE.
39: */
40:
41: package org.dspace.app.xmlui.aspect.submission;
42:
43: import java.io.IOException;
44: import java.sql.SQLException;
45:
46: import org.dspace.app.xmlui.utils.UIException;
47: import org.dspace.app.xmlui.wing.WingException;
48: import org.dspace.app.xmlui.wing.element.List;
49: import org.dspace.authorize.AuthorizeException;
50: import org.xml.sax.SAXException;
51:
52: /**
53: * This abstract class represents an abstract submission page.
54: * <P>
55: * This class only adds the required "addReviewSection()"
56: * method for a submission step. This method is used by the
57: * ReviewStep to generate a single review/verify screen for the user.
58: *
59: * @author Tim Donohue
60: */
61: abstract public class AbstractSubmissionStep extends AbstractStep {
62: /**
63: * Each submission step must define its own information to be reviewed
64: * during the final Review/Verify Step in the submission process.
65: * <P>
66: * The information to review should be tacked onto the passed in
67: * List object.
68: * <P>
69: * NOTE: To remain consistent across all Steps, you should first
70: * add a sub-List object (with this step's name as the heading),
71: * by using a call to reviewList.addList(). This sublist is
72: * the list you return from this method!
73: *
74: * @param reviewList
75: * The List to which all reviewable information should be added
76: * @return
77: * The new sub-List object created by this step, which contains
78: * all the reviewable information. If this step has nothing to
79: * review, then return null!
80: */
81: public abstract List addReviewSection(List reviewList)
82: throws SAXException, WingException, UIException,
83: SQLException, IOException, AuthorizeException;
84: }
|