Package com.groiss.dms

Interface FormType

public interface FormType
The type of a DMSForm

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DOCUMENT_FORM
    Determines that this formtype is a document
    static final long
    EMAIL
    Holds the oid of the formtype of emails
    static final int
    FOLDER_FORM
    Determines that this formtype is a folder
    static final String
    FORM_PACKAGE
    Deprecated.
    can be configured.
    static final long
    MESSAGE_TEMPLATE
    Holds the oid of the formtype for message templates
    static final long
    NEWS
    Holds the oid of the formtype of news
    static final long
    NOTE
    Holds the oid of the formtype of notes
    static final int
    PROCESS_FORM
    Determines that this formtype is a form
    static final long
    PROFILEPICTURE
    Holds the oid of the formtype of profile pictures
    static final long
    RECENTLYUSED
    Holds the oid of the formtype for the recently used folders
    static final long
    RECYCLEBIN
    Holds the oid of the formtype of recycle bins
    static final long
    STANDARD_DOCUMENT
    Holds the oid of the formtype of standard documents
    static final long
    STANDARD_FOLDER
    Holds the oid of the formtype of standard folders
    static final int
    TEMPLATE_HTML
    template type is HTML
    static final int
    TEMPLATE_XFORMS
    template type is XFORMS
    static final int
    TEMPLATE_XHTML
    template type is XHTML
    static final long
    VALUE
    Holds the oid of the formtype of values
    static final long
    VALUELIST
    Holds the oid of the formtype of valuelists
    static final long
    WEBLINK
    Holds the oid of the formtype of web links

  • Method Summary

    Modifier and Type
    Method
    Description
    List<FormField>
    fieldList(int... includedTypes)
    Return the fields of this form type.
    Application
    getApplication()
    Returns the application of this form type.
    String
    getClassName()
    Returns the full qualified name of the class implementing the DMSForm represented by this FormType.
    String
    getDescription()
    Returns the description of the FormType.
    String
    getDMSTableHandler()
    Returns the name of the class specified as DMSTableHandler.
    String
    getFileFilter()
    Returns a string defining patterns to restrict the types of accepted files by this formtype (only relevant for FormTypes of Type DOCUMENT_FORM).
    int
    getHeight()
     
    String
    getId()
    Return the id of the FormType.
    int
    getKind()
    Returns the kind of this FormType (e.g.
    String
    getName()
    Returns the name of the FormType
    long
    getOid()
    Returns the unique oid of the object.
    String
    getTableDefinition()
     
    FormField
    getTableField(int subtableid)
    Return the form-field for the subform table with the given id.
    int
    getTemplateType()
    type of form template: HTML, XHTML, XFORM
    int
    getVersion()
    Return the version of the FormType.
    int
    getWidth()
     
    String
    getXhtmlPage()
    returns the location of the xhtml-template
    DMSForm
    newInstance()
    Creates a new instance of the DMSForm represented by this FormType, but does not insert it to the database (therefore the returned DMSForm will not have an oid set).

  • Field Details

    • PROCESS_FORM

      static final int PROCESS_FORM
      Determines that this formtype is a form
      See Also:

    • DOCUMENT_FORM

      static final int DOCUMENT_FORM
      Determines that this formtype is a document
      See Also:

    • FOLDER_FORM

      static final int FOLDER_FORM
      Determines that this formtype is a folder
      See Also:

    • NOTE

      static final long NOTE
      Holds the oid of the formtype of notes
      See Also:

    • STANDARD_DOCUMENT

      static final long STANDARD_DOCUMENT
      Holds the oid of the formtype of standard documents
      See Also:

    • STANDARD_FOLDER

      static final long STANDARD_FOLDER
      Holds the oid of the formtype of standard folders
      See Also:

    • NEWS

      static final long NEWS
      Holds the oid of the formtype of news
      See Also:

    • VALUELIST

      static final long VALUELIST
      Holds the oid of the formtype of valuelists
      See Also:

    • VALUE

      static final long VALUE
      Holds the oid of the formtype of values
      See Also:

    • EMAIL

      static final long EMAIL
      Holds the oid of the formtype of emails
      See Also:

    • PROFILEPICTURE

      static final long PROFILEPICTURE
      Holds the oid of the formtype of profile pictures
      See Also:

    • RECYCLEBIN

      static final long RECYCLEBIN
      Holds the oid of the formtype of recycle bins
      See Also:

    • RECENTLYUSED

      static final long RECENTLYUSED
      Holds the oid of the formtype for the recently used folders
      See Also:

    • MESSAGE_TEMPLATE

      static final long MESSAGE_TEMPLATE
      Holds the oid of the formtype for message templates
      See Also:

    • TEMPLATE_HTML

      static final int TEMPLATE_HTML
      template type is HTML
      See Also:

    • TEMPLATE_XHTML

      static final int TEMPLATE_XHTML
      template type is XHTML
      See Also:

    • TEMPLATE_XFORMS

      static final int TEMPLATE_XFORMS
      template type is XFORMS
      See Also:

    • FORM_PACKAGE

      @Deprecated static final String FORM_PACKAGE
      Deprecated.
      can be configured. Use Settings.getFormPackage() instead.
      See Also:

  • Method Details

    • getTableDefinition

      String getTableDefinition()

    • getOid

      long getOid()
      Returns the unique oid of the object.
      Returns:
      the oid

    • getId

      String getId()
      Return the id of the FormType.
      Returns:
      the id

    • getVersion

      int getVersion()
      Return the version of the FormType.
      Returns:
      the version, a natural number

    • getName

      String getName()
      Returns the name of the FormType
      Returns:
      the name, a string object

    • getClassName

      String getClassName()
      Returns the full qualified name of the class implementing the DMSForm represented by this FormType.

    • getDescription

      String getDescription()
      Returns the description of the FormType.

    • newInstance

      DMSForm newInstance()
      Creates a new instance of the DMSForm represented by this FormType, but does not insert it to the database (therefore the returned DMSForm will not have an oid set).

    • getKind

      int getKind()
      Returns the kind of this FormType (e.g. PROCESS_FORM)

    • getWidth

      int getWidth()

    • getHeight

      int getHeight()

    • getDMSTableHandler

      String getDMSTableHandler()
      Returns the name of the class specified as DMSTableHandler. This is only usefull for formtypes of type FOLDER_FORM

    • getTemplateType

      int getTemplateType()
      type of form template: HTML, XHTML, XFORM

    • getXhtmlPage

      String getXhtmlPage()
      returns the location of the xhtml-template
      Returns:
      the location of the xhtml-template

    • getFileFilter

      String getFileFilter()
      Returns a string defining patterns to restrict the types of accepted files by this formtype (only relevant for FormTypes of Type DOCUMENT_FORM). See description of HTML file input attribute 'accept' for the syntax of such patterns.
      Returns:
      the patterns of accepted file types

    • fieldList

      List<FormField> fieldList(int... includedTypes)
      Return the fields of this form type.
      Parameters:
      includedTypes - if not empty, the result is restricted to the field types in the list.
      Returns:
      a list of form fields

    • getTableField

      FormField getTableField(int subtableid)
      Return the form-field for the subform table with the given id.
      Parameters:
      subtableid - id of the subform table
      Returns:
      a form field or null

    • getApplication

      Application getApplication()
      Returns the application of this form type.
      Returns:
      the application