Package org.silverpeas.core.workflow.api.model

Interface Form

  • All Known Implementing Classes:
    FormImpl
    public interface Form
    Interface describing a representation of the <Form> element of a Process Model.

    • Method Detail

      • getName

        String getName()
        Get the name of this form
        Returns:
        form's name

      • setName

        void setName​(String name)
        Set the name of this form
        Parameters:
        name - form's name

      • getRole

        String getRole()
        Get the role
        Returns:
        the role name

      • setRole

        void setRole​(String role)
        Set the role name
        Parameters:
        role - name to set

      • getHTMLFileName

        String getHTMLFileName()
        Get the name of HTML file to show this form if no HTML file is defined, XMLForm will be used to display the form
        Returns:
        form's name

      • setHTMLFileName

        void setHTMLFileName​(String htmlFileName)
        Set the name of HTML file to show this form if no HTML file is defined, XMLForm will be used to display the form

      • getInputs

        Input[] getInputs()
        Get the inputs
        Returns:
        the inputs as a Vector

      • getInput

        Input getInput​(int idx)
        Get the input specified by the index
        Parameters:
        idx - the index
        Returns:
        the items as a Vector

      • getInput

        Input getInput​(Input reference)
        Get the input specified by item and / or value
        Parameters:
        reference - the reference object
        Returns:
        the items as a Vector

      • createInput

        Input createInput()
        Create and return and object implementing Input

      • iterateInput

        Iterator<Input> iterateInput()
        Iterate through the inputs
        Returns:
        an iterator

      • addInput

        void addInput​(Input input)
        Add an input

      • getTitles

        ContextualDesignations getTitles()
        Get all the titles
        Returns:
        an object containing the collection of the tables

      • getTitle

        String getTitle​(String role,
                String language)
        Get title in specific language for the given role
        Parameters:
        language - title's language
        role - role for which the title is
        Returns:
        wanted title as a String object. If title is not found, search title with given role and default language, if not found again, return the default title in given language, if not found again, return the default title in default language, if not found again, return empty string.

      • getDefaultRecord

        org.silverpeas.core.contribution.content.form.DataRecord getDefaultRecord​(String role,
                                                                          String lang,
                                                                          org.silverpeas.core.contribution.content.form.DataRecord data)
                                                                   throws WorkflowException
        Converts this object in a DataRecord object
        Returns:
        the resulting DataRecord object with the default values set
        Throws:
        WorkflowException

      • toRecordTemplate

        org.silverpeas.core.contribution.content.form.RecordTemplate toRecordTemplate​(String roleName,
                                                                              String language)
                                                                       throws WorkflowException
        Converts this object in a RecordTemplate object
        Returns:
        the resulting RecordTemplate
        Throws:
        WorkflowException

      • toRecordTemplate

        org.silverpeas.core.contribution.content.form.RecordTemplate toRecordTemplate​(String roleName,
                                                                              String language,
                                                                              boolean readOnly)
                                                                       throws WorkflowException
        Converts this object in a RecordTemplate object
        Returns:
        the resulting RecordTemplate
        Throws:
        WorkflowException