Package org.dspace.app.util

Class 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

    • 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 <step-definitions> 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")

      • getType

        public String getType()
        Retrieve the name of the component used by this step in the UI
        Returns:
        the name of the UI component to use for this step

      • getScope

        public String getScope()
        Returns:
        the scope restriction for this step

      • getVisibility

        public String getVisibility()

      • getVisibilityOutside

        public String getVisibilityOutside()

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

      • 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

      • isMandatory

        public boolean isMandatory()