Interface WizardStepBean

    • Method Detail

      • getPosition

        int getPosition()
        Returns step position it represents.
        Returns:
        int
      • setPosition

        void setPosition​(int position)
        Sets step position it represents.
        Parameters:
        position - integer value indicating step position on the wizard
      • getValidationErrorMessage

        java.lang.String getValidationErrorMessage()
        Return generic error message text.
        Returns:
        String
      • isRequired

        boolean isRequired()
        Informs whether this step is required to be completed.
        Returns:
        true if required.
      • setIsRequired

        void setIsRequired​(boolean value)
        Specifies whether this step is required to proceed through.
        Parameters:
        value - boolean indicating if it's required or not.
      • isCompleted

        boolean isCompleted()
        Informs whether this step has been completed or not.
        Returns:
        true if completed.
      • setCompleted

        void setCompleted​(boolean value)
        Specifies completion for this step.
        Parameters:
        value - boolean value true if completed.
      • renderOnAnyStatus

        boolean renderOnAnyStatus()
        Checks whether to render the step regardless of the status of the target bean.
        Returns:
        true if to be rendered.
      • setRenderOnAnyStatus

        void setRenderOnAnyStatus​(boolean value)
        Specify the wizard to render the step regardless of the status of the target bean.
        Parameters:
        value - boolean value true if to be rendered.
      • isFinal

        boolean isFinal()
        Indicates the step is final and no more steps will be displayed by the wizard.
        Returns:
        true if final.
      • setFinal

        void setFinal​(boolean value)
        Specifies whether given step is final.
        Parameters:
        value - boolean value, true if final.
      • setTargetBean

        void setTargetBean​(WebComponent targetBean)
        Assigns a target bean to be manipulate by the step.
        Specified by:
        setTargetBean in interface WebComponent
        Parameters:
        targetBean - bean instance.
      • setExecutionEventID

        void setExecutionEventID​(int value)
        Sets the event to be triggered by the client when the wizars is closed
        Parameters:
        value - an event id
      • getPromptEvent

        java.lang.String getPromptEvent()
        Returns the event to be triggered by the client when the status has been changed to WaitingForUser Input
        Returns:
        an event id
      • setPromptEvent

        void setPromptEvent​(java.lang.String value)
        Sets the event to be triggered by the client when the status has been changed to WaitingForUser Input
        Parameters:
        value - an event id
      • getPreviousEventID

        int getPreviousEventID()
        Returns the event to be triggered by the client when the Previous button is clicked.
        Returns:
        an event id
      • setPreviousEventID

        void setPreviousEventID​(int value)
        Sets the event to be triggered by the client when the Previous button is cliked.
        Parameters:
        value - an event id
      • getExecutionEventID

        int getExecutionEventID()
        Returns the event to be triggered by the client when the wizars is closed
        Returns:
        int an event id.
      • setBodyMessage

        void setBodyMessage​(java.lang.String value)
        Sets the the step's body message.
        The body message is a String that can be used by a Transform. It's a piece of text that can be placed anywhere on the step's body.
        Parameters:
        value - the step's body message.
      • getBodyMessage

        java.lang.String getBodyMessage()
        The body message is a String that can be used by a Transform. It's a piece of text that can be placed anywhere on the step's body.
        Returns:
        String the step's body message.
      • getXMLStatus

        int getXMLStatus()
        Indicates which XML bean request status this step can be executed
        Specified by:
        getXMLStatus in interface WebComponent
        Returns:
        int EnumRequestStatus value
      • setXMLStatus

        void setXMLStatus​(int value)
        Specifies in which XML bean request status this step can be executed
        Parameters:
        value - value obtained from EnumRequestStatus