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

Class CCLicenseStep

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

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

This is an optional page of the item submission processes. The Creative Commons license may be added to an item in addition to the standard distribution license. This step will allow the user to go off to the creative commons website select a license and then when returned view what license was added to the item.

This class is called by org.dspace.app.xmlui.submission.step.LicenseStep when the Creative Commons license is enabled

The form is divided into three major divisions: 1) A global div surrounds the whole page, 2) a specific interactive div displays the button that goes off to the creative commons website to select a license, and 3) a local division that displays the selected license and standard action bar.

Author:

Scott Phillips, Tim Donohue (updated for Configurable Submission), Wendy Bossons (updated for DSpace 1.8)

Field Summary

Fields

Modifier and Type	Field and Description
protected static Message	T_ccws_error
protected static Message	T_head Language Strings
protected static Message	T_info1
protected static Message	T_license
protected static Message	T_no_license
protected static Message	T_save_changes
protected static Message	T_select
protected static Message	T_select_change
protected static Message	T_submit_issue_creative_commons
protected static Message	T_submit_remove
protected static Message	T_submit_to_creative_commons

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_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
CCLicenseStep() 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.
void	recycle() Recycle

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

addControlButtons, addJumpButton, addPageMeta, 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_select

protected static final Message T_select

T_info1

protected static final Message T_info1

T_submit_to_creative_commons

protected static final Message T_submit_to_creative_commons

T_submit_issue_creative_commons

protected static final Message T_submit_issue_creative_commons

T_license

protected static final Message T_license

T_submit_remove

protected static final Message T_submit_remove

T_no_license

protected static final Message T_no_license

T_select_change

protected static final Message T_select_change

T_save_changes

protected static final Message T_save_changes

T_ccws_error

protected static final Message T_ccws_error

Constructor Detail

CCLicenseStep

public CCLicenseStep()

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

recycle

public void recycle()

Recycle

Specified by:

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

Overrides:

recycle in class AbstractStep