org.dspace.app.util

Class SubmissionStepConfig

java.lang.Object

org.dspace.app.util.SubmissionStepConfig

All Implemented Interfaces:

Serializable

public class SubmissionStepConfig
extends Object
implements Serializable

Class representing configuration for a single step within an Item Submission Process. In other words, this is a single step in the SubmissionConfig class. This class represents the structure of a single 'step' node in the item-submission.xml configuration file. Note: Implements Serializable as it will be saved to the current session during submission. Please ensure that nothing is added to this class that isn't also serializable

Version:

$Revision$

Author:

Tim Donohue

See Also:

SubmissionConfigReader, SubmissionConfig, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPLETE_STEP
static String	SELECT_COLLECTION_STEP

Constructor Summary

Constructors

Constructor and Description
SubmissionStepConfig() Class constructor for creating an empty SubmissionStepConfig object
SubmissionStepConfig(Map<String,String> stepMap) Class constructor for creating a SubmissionStepConfig object based on the contents of a HashMap initialized by the SubmissionConfig object.

Method Summary

Methods

Modifier and Type	Method and Description
String	getHeading() Get the heading for this step.
String	getId() Get the ID for this step.
String	getJSPUIClassName() Retrieve the full class name of the JSP-UI "binding" class which will initialize and call the necessary JSPs for display in the JSP-UI This class must extend the org.dspace.app.webui.submit.JSPStep class.
String	getProcessingClassName() Get the class which handles all processing for this step.
int	getStepNumber() Get the number of this step in the current Submission process config.
String	getXMLUIClassName() Retrieve the full class name of the Manakin Transformer which will generate this step's DRI, for display in Manakin XML-UI.
boolean	isVisible() Whether or not this step is visible within the Progress Bar.
boolean	isWorkflowEditable() Whether or not this step is editable during workflow processing.
protected void	setStepNumber(int stepNum) Sets the number of this step in the current Submission process config.

Methods inherited from class java.lang.Object

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

Field Detail

SELECT_COLLECTION_STEP

public static final String SELECT_COLLECTION_STEP

See Also:

Constant Field Values

COMPLETE_STEP

public static final String COMPLETE_STEP

See Also:

Constant Field Values

Constructor Detail

SubmissionStepConfig

public SubmissionStepConfig()

Class constructor for creating an empty SubmissionStepConfig object

SubmissionStepConfig

public SubmissionStepConfig(Map<String,String> stepMap)

Class constructor for creating a SubmissionStepConfig object based on the contents of a HashMap initialized by the SubmissionConfig object.

Parameters:

stepMap - the HashMap containing all required information about this step

Method Detail

getId

public String getId()

Get the ID for this step. An ID is only defined if the step exists in the section. This ID field is used to reference special steps (like the required step with id="collection")

Returns:

the step ID

getHeading

public String getHeading()

Get the heading for this step. This can either be a property from Messages.properties, or the actual heading text. If this "heading" contains a period(.) it is assumed to reference Messages.properties.

Returns:

the heading

getProcessingClassName

public String getProcessingClassName()

Get the class which handles all processing for this step.

This class must extend the org.dspace.submit.AbstractProcessingStep class, and provide processing for BOTH the JSP-UI and XML-UI

Returns:

the class's full class path (e.g. "org.dspace.submit.step.MySampleStep")

getXMLUIClassName

public String getXMLUIClassName()

Retrieve the full class name of the Manakin Transformer which will generate this step's DRI, for display in Manakin XML-UI.

This class must extend the org.dspace.app.xmlui.aspect.submission.StepTransformer class.

This property is only used by the Manakin XML-UI, and therefore is not relevant if you are using the JSP-UI.

Returns:

the full java class name of the Transformer to use for this step

getJSPUIClassName

public String getJSPUIClassName()

Retrieve the full class name of the JSP-UI "binding" class which will initialize and call the necessary JSPs for display in the JSP-UI

This class must extend the org.dspace.app.webui.submit.JSPStep class.

This property is only used by the JSP-UI, and therefore is not relevant if you are using the XML-UI (aka. Manakin).

Returns:

the full java class name of the JSPStep to use for this step

getStepNumber

public int getStepNumber()

Get the number of this step in the current Submission process config. Step numbers start with #0 (although step #0 is ALWAYS the special "select collection" step)

Returns:

the number of this step in the current SubmissionConfig

setStepNumber

protected void setStepNumber(int stepNum)

Sets the number of this step in the current Submission process config. Step numbers start with #0 (although step #0 is ALWAYS the special "select collection" step)

Parameters:

stepNum - the step number.

isWorkflowEditable

public boolean isWorkflowEditable()

Whether or not this step is editable during workflow processing. If "true", then this step will appear in the "Edit Metadata" stage of the workflow process.

Returns:

if step is editable in a workflow process

isVisible

public boolean isVisible()

Whether or not this step is visible within the Progress Bar. A step is only visible if it has been assigned a Heading, otherwise it's invisible

Returns:

if step is visible within the progress bar