Package nl.gx.forms.wmpformapi.api.form

Interface FormSection

    • Method Detail

      • getCategory

        FormCategory getCategory()
        Returns the category for this form.
        Returns:
        the category for this form

      • setCategory

        void setCategory​(FormCategory formCategory)
        Sets or updates the category for this form.
        Parameters:
        formCategory - the new category for this form

      • setActiveVersion

        @Deprecated
void setActiveVersion​(BasicFormSectionVersion version)
        Deprecated.
        no longer necessary to set active version, as it will be determined using publication status and publication and expiration date
        Sets the active verion for this form.
        Parameters:
        version - the new active version

      • setVersions

        void setVersions​(List<BasicFormSectionVersion> formVersions)
        Updates the set of versions for this form.
        Parameters:
        formVersions - the new set of versions for this form.

      • createVersion

        FormSectionVersion createVersion()
        Creates an formSectionVersion with without fragments

      • createVersion

        FormSectionVersion createVersion​(FormSectionVersion basedOn)
        Creates an formVersionSection based on the formSectionVersion
        Parameters:
        basedOn - the formSectionVersion which is copied

      • appendVersion

        void appendVersion​(FormSectionVersion version)
        Adds a FormSectionVersion to this FormSection. Meant to be used from the importer.
        Parameters:
        version - the version to add

      • deleteVersion

        void deleteVersion​(FormSectionVersion formSectionVersion)
        Deletes the formSectionVersion
        Parameters:
        formSectionVersion - form section version to be deleted

      • setIdentifier

        void setIdentifier​(String identifier)
        Sets or updates the identifier for this formsection.
        Parameters:
        identifier - the new identifier for this formsection

      • getWmId

        WmId getWmId()
        Returns the WebManager ID (UUID) for this form step.
        Returns:
        the WebManager ID (UUID) for this form step

      • getOriginIdentifier

        String getOriginIdentifier()
        Returns a unique identifier that is created when a new Form is created. However, when a form is imported and then exported, this identifier does not change. This can be used to uniquely identify a Form across different installations and is intented to be used for matching Form's when importing.
        Returns:
        a String identifying the origin of this Form

      • setOriginIdentifier

        void setOriginIdentifier​(String originIdentifier)
        Sets a unique identifier that is created when a new Form is created. However, when a form is imported and then exported, this identifier does not change. This can be used to uniquely identify a Form across different installations and is intented to be used for matching Form's when importing.
        Parameters:
        originIdentifier - a String identifying the origin of this Form

      • getWebsiteId

        int getWebsiteId()
        The identifier of the Website this FormSection belongs to.
        Returns:
        identifier of the Website this FormSection belongs to

      • setWebsiteId

        void setWebsiteId​(int webid)
        Sets the identifier of the Website this FormSection belongs to.
        Parameters:
        webid - identifier of the Website this FormSection belongs to

      • getReferingFormFragments

        List<FormFragment> getReferingFormFragments()
        Returns the form fragments which are using this formsection.
        Returns:
        the form fragments which are using this formsection.

      • getWorkflowModel

        WorkflowModel getWorkflowModel()
        Returns the workflow model associated with this FormSection.
        Returns:
        the workflow model associated with this FormSection