org.dspace.app.xmlui.aspect.submission.submit
Class ReviewStep

java.lang.Object
  org.apache.cocoon.util.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.xml.AbstractXMLPipe
              org.apache.cocoon.transformation.AbstractTransformer
                  org.dspace.app.xmlui.wing.AbstractWingTransformer
                      org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer
                          org.dspace.app.xmlui.aspect.submission.AbstractStep
                              org.dspace.app.xmlui.aspect.submission.AbstractSubmissionStep
                                  org.dspace.app.xmlui.aspect.submission.submit.ReviewStep

All Implemented Interfaces:

org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, org.apache.cocoon.sitemap.SitemapModelComponent, org.apache.cocoon.transformation.Transformer, org.apache.cocoon.xml.XMLPipe, org.apache.cocoon.xml.XMLProducer, org.apache.excalibur.xml.sax.XMLConsumer, DSpaceTransformer, WingTransformer, org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler

public class ReviewStep
extends AbstractSubmissionStep

This is a step of the item submission processes. This is where the user reviews everything they have entered about the item up to this point.

This step is dynamic, since when using the Configurable Submission it is unknown what steps are available and in what order.

This step builds a form with which consists of a separate section for each step which implements the "addReviewSection()" method of AbstractSubmissionStep class.

Author:

Scott Phillips, Tim Donohue (updated for Configurable Submission)

Field Summary

protected static Message	T_head Language Strings
protected static Message	T_known
protected static Message	T_no
protected static Message	T_no_metadata
protected static Message	T_submit_jump
protected static Message	T_supported
protected static Message	T_unknown
protected static Message	T_yes

Fields inherited from class org.dspace.app.xmlui.aspect.submission.AbstractStep

errorFields, errorFlag, handle, id, requireHandle, requireStep, requireSubmission, requireWorkflow, requireWorkspace, stepAndPage, submission, submissionInfo, T_complete, T_creative_commons, T_default_title, T_default_trail, T_describe, T_dspace_home, T_initial_questions, T_license, T_next, T_previous, T_review, T_save, T_showfull, T_showsimple, T_submission_head, T_submission_title, T_submission_trail, T_upload, T_workflow_head, T_workflow_title, T_workflow_trail

Fields inherited from class org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer

context, contextPath, eperson, knot, objectModel, parameters, servletPath, sitemapURI, url

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.transformation.Transformer

ROLE

Constructor Summary

ReviewStep()
Establish our required parameters, abstractStep will enforce these.

Method Summary

void	addBody(Body body) What to add at the end of the body
List	addReviewSection(List reviewList) Each submission step must define its own information to be reviewed during the final Review/Verify Step in the submission process.
void	setup(org.apache.cocoon.environment.SourceResolver resolver, java.util.Map objectModel, java.lang.String src, org.apache.avalon.framework.parameters.Parameters parameters) Save these setup parameters, to use for loading up the previous step's review information

Methods inherited from class org.dspace.app.xmlui.aspect.submission.AbstractStep

addControlButtons, addJumpButton, addPageMeta, addSubmissionProgressList, getErrorFields, getMaxStepAndPageReached, getPage, getStep, isFirstStep, isLastStep, recycle

Methods inherited from class org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer

addOptions, addUserMeta, decodeFromURL, dispose, encodeForURL, generateURL, getComponentName, getObjectManager, handleException

Methods inherited from class org.dspace.app.xmlui.wing.AbstractWingTransformer

createWingDocument, endDocument, endElement, endPrefixMapping, getDefaultMessageCatalogue, message, message, setupWing, startDocument, startElement, startPrefixMapping

Methods inherited from class org.apache.cocoon.xml.AbstractXMLPipe

characters, comment, endCDATA, endDTD, endEntity, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDTD, startEntity

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xml.sax.ContentHandler

characters, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity

Methods inherited from interface org.xml.sax.ext.LexicalHandler

comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Detail

T_head

protected static final Message T_head

Language Strings

T_yes

protected static final Message T_yes

T_no

protected static final Message T_no

T_submit_jump

protected static final Message T_submit_jump

T_no_metadata

protected static final Message T_no_metadata

T_unknown

protected static final Message T_unknown

T_known

protected static final Message T_known

T_supported

protected static final Message T_supported

Constructor Detail

ReviewStep

public ReviewStep()

Establish our required parameters, abstractStep will enforce these.

Method Detail

setup

public void setup(org.apache.cocoon.environment.SourceResolver resolver,
                  java.util.Map objectModel,
                  java.lang.String src,
                  org.apache.avalon.framework.parameters.Parameters parameters)
           throws org.apache.cocoon.ProcessingException,
                  org.xml.sax.SAXException,
                  java.io.IOException

Save these setup parameters, to use for loading up the previous step's review information

Specified by:

setup in interface org.apache.cocoon.sitemap.SitemapModelComponent

Overrides:

setup in class AbstractStep

Throws:

org.apache.cocoon.ProcessingException

org.xml.sax.SAXException

java.io.IOException

addBody

public void addBody(Body body)
             throws org.xml.sax.SAXException,
                    WingException,
                    UIException,
                    java.sql.SQLException,
                    java.io.IOException,
                    AuthorizeException

Description copied from class: AbstractDSpaceTransformer

What to add at the end of the body

Specified by:

addBody in interface DSpaceTransformer

Specified by:

addBody in interface WingTransformer

Overrides:

addBody in class AbstractDSpaceTransformer

Throws:

org.xml.sax.SAXException

WingException

UIException

java.sql.SQLException

java.io.IOException

AuthorizeException

addReviewSection

public List addReviewSection(List reviewList)
                      throws org.xml.sax.SAXException,
                             WingException,
                             UIException,
                             java.sql.SQLException,
                             java.io.IOException,
                             AuthorizeException

Each submission step must define its own information to be reviewed during the final Review/Verify Step in the submission process.

The information to review should be tacked onto the passed in List object.

NOTE: To remain consistent across all Steps, you should first add a sub-List object (with this step's name as the heading), by using a call to reviewList.addList(). This sublist is the list you return from this method!

Specified by:

addReviewSection in class AbstractSubmissionStep

Parameters:

reviewList - The List to which all reviewable information should be added

Returns:

The new sub-List object created by this step, which contains all the reviewable information. If this step has nothing to review, then return null!

Throws:

org.xml.sax.SAXException

WingException

UIException

java.sql.SQLException

java.io.IOException

AuthorizeException