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

Class InitialQuestionsStep

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.InitialQuestionsStep

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, ContentHandler, LexicalHandler

public class InitialQuestionsStep
extends AbstractSubmissionStep

This is the first official step of the item submission processes. This step will ask the user two questions which will direct whether future questions will be asked of the user. Since they user may move next or previous or even jump around between the stages some metadata values may already be filled for selected values. i.e. if the user selected that there may be multiple titles and then later comes back and unchecks then multiple titles box. In this case these metadata entries are removed from the item, a note is displayed informing the user of this discrepency. Questions: - Multiple titles - Published Before

Author:

Scott Phillips, Tim Donohue (updated for Configurable Submission)

Field Summary

Fields

Modifier and Type	Field and Description
protected static Message	T_and
protected static Message	T_citation
protected static Message	T_close
protected static Message	T_date_issued
protected static Message	T_head Language Strings
protected static Message	T_important_note
protected static Message	T_multiple_titles
protected static Message	T_multiple_titles_help
protected static Message	T_multiple_titles_note
protected static Message	T_open
protected static Message	T_published_before
protected static Message	T_published_before_help
protected static Message	T_published_before_note
protected static Message	T_publisher
protected static Message	T_separator

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

Constructors

Constructor and Description
InitialQuestionsStep() Establish our required parameters, abstractStep will enforce these.

Method Summary

Methods

Modifier and Type	Method and Description
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.

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

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

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_important_note

protected static final Message T_important_note

T_and

protected static final Message T_and

T_separator

protected static final Message T_separator

T_open

protected static final Message T_open

T_close

protected static final Message T_close

T_multiple_titles

protected static final Message T_multiple_titles

T_multiple_titles_help

protected static final Message T_multiple_titles_help

T_multiple_titles_note

protected static final Message T_multiple_titles_note

T_published_before

protected static final Message T_published_before

T_published_before_help

protected static final Message T_published_before_help

T_published_before_note

protected static final Message T_published_before_note

T_date_issued

protected static final Message T_date_issued

T_citation

protected static final Message T_citation

T_publisher

protected static final Message T_publisher

Constructor Detail

InitialQuestionsStep

public InitialQuestionsStep()

Establish our required parameters, abstractStep will enforce these.

Method Detail

addBody

public void addBody(Body body)
             throws SAXException,
                    WingException,
                    UIException,
                    SQLException,
                    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:

SAXException

WingException

UIException

SQLException

IOException

AuthorizeException

addReviewSection

public List addReviewSection(List reviewList)
                      throws SAXException,
                             WingException,
                             UIException,
                             SQLException,
                             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:

SAXException

WingException

UIException

SQLException

IOException

AuthorizeException