org.dspace.app.util

Class SubmissionConfigReader

java.lang.Object

org.dspace.app.util.SubmissionConfigReader

public class SubmissionConfigReader
extends Object

Item Submission configuration generator for DSpace. Reads and parses the installed submission process configuration file, item-submission.xml, from the configuration directory. This submission process definition details the ordering of the steps (and number of steps) that occur during the Item Submission Process. There may be multiple Item Submission processes defined, where each definition is assigned a unique name. The file also specifies which collections use which Item Submission process. At a minimum, the definitions file must define a default mapping from the placeholder collection # to the distinguished submission process 'default'. Any collections that use a custom submission process are listed paired with the name of the item submission process they use.

Version:

$Revision$

Author:

Tim Donohue based on DCInputsReader by Brian S. Hughes

See Also:

SubmissionConfig, SubmissionStepConfig

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_COLLECTION The ID of the default collection.

Constructor Summary

Constructors

Constructor and Description
SubmissionConfigReader() Load Submission Configuration from the item-submission.xml configuration file

Method Summary

Methods

Modifier and Type	Method and Description
SubmissionStepConfig	getStepConfig(String stepID) Returns a particular global step definition based on its ID.
SubmissionConfig	getSubmissionConfig(String collectionHandle, boolean isWorkflow) Returns the Item Submission process config used for a particular collection, or the default if none is defined for the collection

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COLLECTION

public static final String DEFAULT_COLLECTION

The ID of the default collection. Will never be the ID of a named collection

See Also:

Constant Field Values

Constructor Detail

SubmissionConfigReader

public SubmissionConfigReader()
                       throws javax.servlet.ServletException

Load Submission Configuration from the item-submission.xml configuration file

Throws:

javax.servlet.ServletException

Method Detail

getSubmissionConfig

public SubmissionConfig getSubmissionConfig(String collectionHandle,
                                   boolean isWorkflow)
                                     throws javax.servlet.ServletException

Returns the Item Submission process config used for a particular collection, or the default if none is defined for the collection

Parameters:

collectionHandle - collection's unique Handle

isWorkflow - whether or not we are loading the submission process for a workflow

Returns:

the SubmissionConfig representing the item submission config

Throws:

javax.servlet.ServletException - if no default submission process configuration defined

getStepConfig

public SubmissionStepConfig getStepConfig(String stepID)
                                   throws javax.servlet.ServletException

Returns a particular global step definition based on its ID.

Global step definitions are those defined in the section of the configuration file.

Parameters:

stepID - step's identifier

Returns:

the SubmissionStepConfig representing the step

Throws:

javax.servlet.ServletException - if no default submission process configuration defined