org.dspace.submit.step

Class CompleteStep

java.lang.Object

org.dspace.submit.AbstractProcessingStep

org.dspace.submit.step.CompleteStep

public class CompleteStep
extends AbstractProcessingStep

This is the class which defines what happens once a submission completes!

This class performs all the behind-the-scenes processing that this particular step requires. This class's methods are utilized by both the JSP-UI and the Manakin XML-UI

This step is non-interactive (i.e. no user interface), and simply performs the processing that is necessary after a submission has been completed!

Version:

$Revision$

Author:

Tim Donohue

See Also:

SubmissionConfig, SubmissionStepConfig, AbstractProcessingStep

Field Summary

Fields inherited from class org.dspace.submit.AbstractProcessingStep

authorizeService, bitstreamService, bundleService, CANCEL_BUTTON, collectionService, configurationService, itemService, LAST_PAGE_REACHED, metadataFieldService, NEXT_BUTTON, PREVIOUS_BUTTON, PROGRESS_BAR_PREFIX, SELECT_CHANGE, STATUS_COMPLETE

Constructor Summary

Constructors

Constructor and Description
CompleteStep()

Method Summary

Methods

Modifier and Type	Method and Description
int	doProcessing(Context context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SubmissionInfo subInfo) Do any processing of the information input by the user, and/or perform step processing (if no user interaction required)
int	getNumberOfPages(javax.servlet.http.HttpServletRequest request, SubmissionInfo subInfo) Retrieves the number of pages that this "step" extends over.

Methods inherited from class org.dspace.submit.AbstractProcessingStep

addErrorField, addErrorMessage, clearErrorFields, getCurrentPage, getErrorFields, getErrorMessage, setCurrentPage

Methods inherited from class java.lang.Object

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

Constructor Detail

CompleteStep

public CompleteStep()

Method Detail

doProcessing

public int doProcessing(Context context,
               javax.servlet.http.HttpServletRequest request,
               javax.servlet.http.HttpServletResponse response,
               SubmissionInfo subInfo)
                 throws javax.servlet.ServletException,
                        IOException,
                        SQLException,
                        AuthorizeException

Do any processing of the information input by the user, and/or perform step processing (if no user interaction required)

It is this method's job to save any data to the underlying database, as necessary, and return error messages (if any) which can then be processed by the appropriate user interface (JSP-UI or XML-UI)

NOTE: If this step is a non-interactive step (i.e. requires no UI), then it should perform *all* of its processing in this method!

Specified by:

doProcessing in class AbstractProcessingStep

Parameters:

context - current DSpace context

request - current servlet request object

response - current servlet response object

subInfo - submission info object

Returns:

Status or error flag which will be processed by doPostProcessing() below! (if STATUS_COMPLETE or 0 is returned, no errors occurred!)

Throws:

javax.servlet.ServletException

IOException

SQLException

AuthorizeException

getNumberOfPages

public int getNumberOfPages(javax.servlet.http.HttpServletRequest request,
                   SubmissionInfo subInfo)
                     throws javax.servlet.ServletException

Retrieves the number of pages that this "step" extends over. This method is used to build the progress bar.

This method may just return 1 for most steps (since most steps consist of a single page). But, it should return a number greater than 1 for any "step" which spans across a number of HTML pages. For example, the configurable "Describe" step (configured using input-forms.xml) overrides this method to return the number of pages that are defined by its configuration file.

Steps which are non-interactive (i.e. they do not display an interface to the user) should return a value of 1, so that they are only processed once!

Specified by:

getNumberOfPages in class AbstractProcessingStep

Parameters:

request - The HTTP Request

subInfo - The current submission information object

Returns:

the number of pages in this step

Throws:

javax.servlet.ServletException