Interface Form

  • All Superinterfaces:
    BasicForm, Wrapper

    public interface Form
    extends Wrapper, BasicForm
    Form represents a form which can have multiple FormVersions of which typically one is currently active.
    • 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
      • setIdentifier

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

        @Deprecated
        void setActiveVersion​(BasicFormVersion 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<BasicFormVersion> formVersions)
        Updates the set of versions for this form.
        Parameters:
        formVersions - the new set of versions for this form.
      • appendVersion

        void appendVersion​(FormVersion version)
        Appends a version to the list of versions for this Form. Meant for use from the importer.
        Parameters:
        version - the version to append
      • createVersion

        FormVersion createVersion()
        Creates an formVersion with one step, but no form fragments.
        Returns:
        The created FormVersion.
      • createVersion

        FormVersion createVersion​(FormVersion baseOn)
        Creates an formVersion based on the formVersion.
        Parameters:
        baseOn - the formVersion which is copied
        Returns:
        The created FormVersion.
      • deleteVersion

        void deleteVersion​(FormVersion formVersion)
        Deletes the formVersion.
        Parameters:
        formVersion - form version to be deleted
      • getWmId

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

        List<Element> getReferingElements()
        Returns the elements which are using this form.
        Returns:
        the elements which are using this form
      • 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 Form belongs to.
        Returns:
        identifier of the Website this Form belongs to
      • setWebsiteId

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

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