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

Class AccessStep

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHECKBOX_PRIVATE_ITEM
static int	RADIO_OPEN_ACCESS_ITEM_EMBARGOED
static int	RADIO_OPEN_ACCESS_ITEM_VISIBLE
protected static Message	T_head Language Strings
protected static Message	T_policy_head
protected static Message	T_private_item
protected static Message	T_private_label
protected static Message	T_private_settings
protected static Message	T_private_settings_help
protected static Message	T_public_item
protected static Message	T_submit_add_policy

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
AccessStep() Establish our required parameters, abstractStep will enforce these.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBody(Body body) Abstract implementations of WingTransformer.
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	setup(org.apache.cocoon.environment.SourceResolver resolver, Map objectModel, String src, org.apache.avalon.framework.parameters.Parameters parameters) Check if user has requested to edit information about an uploaded file

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

addControlButtons, addJumpButton, 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_submit_add_policy

protected static final Message T_submit_add_policy

T_private_settings

protected static final Message T_private_settings

T_private_settings_help

protected static final Message T_private_settings_help

T_private_label

protected static final Message T_private_label

T_private_item

protected static final Message T_private_item

T_public_item

protected static final Message T_public_item

T_policy_head

protected static final Message T_policy_head

CHECKBOX_PRIVATE_ITEM

public static final int CHECKBOX_PRIVATE_ITEM

See Also:

Constant Field Values

RADIO_OPEN_ACCESS_ITEM_VISIBLE

public static final int RADIO_OPEN_ACCESS_ITEM_VISIBLE

See Also:

Constant Field Values

RADIO_OPEN_ACCESS_ITEM_EMBARGOED

public static final int RADIO_OPEN_ACCESS_ITEM_EMBARGOED

See Also:

Constant Field Values

Constructor Detail

AccessStep

public AccessStep()

Establish our required parameters, abstractStep will enforce these.

Method Detail

setup

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

Check if user has requested to edit information about an uploaded file

Specified by:

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

Overrides:

setup in class AbstractStep

Parameters:

resolver - source resolver.

objectModel - TBD

src - TBD

parameters - sitemap parameters.

Throws:

org.apache.cocoon.ProcessingException - passed through.

SAXException - passed through.

IOException - passed through.

addPageMeta

public void addPageMeta(PageMeta pageMeta)
                 throws WingException,
                        SAXException,
                        SQLException,
                        AuthorizeException,
                        IOException

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

Parameters:

pageMeta - to be added.

Throws:

WingException - passed through.

UIException - passed through.

SAXException - passed through.

SQLException - passed through.

AuthorizeException - passed through.

IOException - passed through.

addBody

public void addBody(Body body)
             throws SAXException,
                    WingException,
                    UIException,
                    SQLException,
                    IOException,
                    AuthorizeException

Description copied from class: AbstractWingTransformer

Abstract implementations of WingTransformer.

Specified by:

addBody in interface DSpaceTransformer

Specified by:

addBody in interface WingTransformer

Overrides:

addBody in class AbstractDSpaceTransformer

Parameters:

body - to be added.

Throws:

SAXException - whenever.

WingException - whenever.

UIException - whenever.

SQLException - whenever.

IOException - whenever.

AuthorizeException - whenever.

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

WingException - whenever.

UIException - whenever.

SQLException - whenever.

IOException - whenever.

AuthorizeException - whenever.