Interface WizardBean

    • Method Detail

      • getAllWizardSteps

        java.util.Enumeration getAllWizardSteps()
        Returns enumeration of all steps in this Wizards.
        Returns:
        Enumeration instance with all the steps
      • getCurrentStep

        WizardStepBean getCurrentStep()
        Returns instance of current step bean.
        Returns:
        WizardStepBean instance of the current step
      • getCurrentPosition

        int getCurrentPosition()
        Returns current step index or position.
        Returns:
        int index position of the current step.
      • setCurrentPosition

        void setCurrentPosition​(int currentPos)
        Sets current step index or position.
        Parameters:
        currentPos - indicating the current index step position.
      • getPreviousStep

        WizardStepBean getPreviousStep()
        Returns instance of previous step bean.
        Returns:
        WizardStepBean instance representing the previous step
      • getTotalSteps

        int getTotalSteps()
        Returns total number of steps in Wizard.
        Returns:
        int number of total steps in wizard.
      • getFinishPage

        java.lang.String getFinishPage()
        Returns name of page where to redirect after processing finish event.
        Returns:
        String page where to go to after finishing the wizard
      • setFinishEventID

        void setFinishEventID​(int value)
        Specifies which event to trigger when Wizard is finished.
        Parameters:
        value - identifier of the event ID to process when the wizard is finished.
      • getFinishEventID

        int getFinishEventID()
        Returns event ID associated to Finishing Wizard flow.
        Returns:
        int identifier of the event ID to process when the wizard is finished.
      • setFinishEventArgs

        void setFinishEventArgs​(java.lang.String value)
        Specifies all arguments of finish Event.
        Parameters:
        value - String representing the different arguments of the finish event (specified by the getFinishEventID() method). This value will have following format: argId1=val1;arg2=val2
      • getFinishEventArgs

        java.lang.String getFinishEventArgs()
        Returns a string consisted of all arguments to be set in Finish event.
        Returns:
        String list of arguments on a string with format like: argId1=val1;arg2=val2
      • setFinishPage

        void setFinishPage​(java.lang.String pageName)
        Specifies name of page where to redirect after processing finish event.
        Parameters:
        pageName - String page name
      • setTargetState

        void setTargetState​(java.lang.String value)
        Used to store the current state of the target bean.
        Parameters:
        value - a String containing the state of the target bean
      • getTargetState

        java.lang.String getTargetState()
        Returns the stored state of the target bean
        Returns:
        the stored state of the target bean
      • setRequiredStep

        void setRequiredStep​(int value)
        Sets the number of the step must be completed before finishing the wizard
        Parameters:
        value - an int with the required step number
      • getRequiredStep

        int getRequiredStep()
        Returns the number of the step must be completed before finishing the wizard
        Returns:
        the required step number