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

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

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 SelectCollectionStep
extends AbstractSubmissionStep

Allow the user to select a collection they wish to submit an item to, this step is sort-of but not officialy part of the item submission processes. Normaly a user will have selected a collection to submit too by going to the collection's page, but if that was invalid or the user came directly from the mydspace page then this step is given.

Author:

Scott Phillips, Tim Donohue (updated for Configurable Submission)

Field Summary

protected static Message	T_collection
protected static Message	T_collection_default
protected static Message	T_collection_help
protected static Message	T_head Language Strings
protected static Message	T_submit_next

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

SelectCollectionStep()

Method Summary

void	addBody(Body body) What to add at the end of the body
void	addPageMeta(PageMeta pageMeta) Base pageMeta that is added to ALL submission stages
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	recycle() Recycle

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

addControlButtons, addJumpButton, addSubmissionProgressList, getErrorFields, getMaxStepAndPageReached, getPage, getStep, isFirstStep, isLastStep, 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_collection

protected static final Message T_collection

T_collection_help

protected static final Message T_collection_help

T_collection_default

protected static final Message T_collection_default

T_submit_next

protected static final Message T_submit_next

Constructor Detail

SelectCollectionStep

public SelectCollectionStep()

Method Detail

addPageMeta

public void addPageMeta(PageMeta pageMeta)
                 throws SAXException,
                        WingException

Description copied from class: AbstractStep

Base pageMeta that is added to ALL submission stages

Specified by:

addPageMeta in interface DSpaceTransformer

Specified by:

addPageMeta in interface WingTransformer

Overrides:

addPageMeta in class AbstractStep

Throws:

SAXException

WingException

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

recycle

public void recycle()

Recycle

Specified by:

recycle in interface org.apache.avalon.excalibur.pool.Recyclable

Overrides:

recycle in class AbstractStep