Package com.saperion.settings

Enum SystemFileKind

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SystemFileKind>
    public enum SystemFileKind
extends java.lang.Enum<SystemFileKind>
    This enumeration holds the types of system files in a Saperion system.
    Author:
    jsc

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ANY
      This enumeration member represents any type of File.
      ANY_NOSYS
      This enumeration member represents any type of File but excludes system wide files.
      DEFS
      This enumeration member represents document definitions (ddc).
      DEFS_NOSYS
      This enumeration member represents document definitions (ddc) but excludes system wide files.
      MACROS
      This enumeration member represents saperion macros (bas).
      MACROS_NOSYS
      This enumeration member represents saperion macros (bas) but excludes system wide files.
      MASK_XML
      This enumeration member represents forms in xml format.
      MASKS
      This enumeration member represents forms (qbe).
      MASKS_NOSYS
      This enumeration member represents forms (qbe) but excludes system wide files.
      WFPROCESS
      This enumeration member represents workflow processes (dfd).
      WFPROCESS_NOSYS
      This enumeration member represents workflow processes (dfd) but excludes system wide files.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getId()  
      static SystemFileKind getInstance​(int id)
      Gets the instance matching to the id.
      boolean getWithDefault()  
      static SystemFileKind valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SystemFileKind[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • DEFS

        public static final SystemFileKind DEFS
        This enumeration member represents document definitions (ddc).

      • MASKS

        public static final SystemFileKind MASKS
        This enumeration member represents forms (qbe).

      • MACROS

        public static final SystemFileKind MACROS
        This enumeration member represents saperion macros (bas).

      • WFPROCESS

        public static final SystemFileKind WFPROCESS
        This enumeration member represents workflow processes (dfd).

      • ANY

        public static final SystemFileKind ANY
        This enumeration member represents any type of File.

      • MASK_XML

        public static final SystemFileKind MASK_XML
        This enumeration member represents forms in xml format.

      • DEFS_NOSYS

        public static final SystemFileKind DEFS_NOSYS
        This enumeration member represents document definitions (ddc) but excludes system wide files.

      • MASKS_NOSYS

        public static final SystemFileKind MASKS_NOSYS
        This enumeration member represents forms (qbe) but excludes system wide files.

      • MACROS_NOSYS

        public static final SystemFileKind MACROS_NOSYS
        This enumeration member represents saperion macros (bas) but excludes system wide files.

      • WFPROCESS_NOSYS

        public static final SystemFileKind WFPROCESS_NOSYS
        This enumeration member represents workflow processes (dfd) but excludes system wide files.

      • ANY_NOSYS

        public static final SystemFileKind ANY_NOSYS
        This enumeration member represents any type of File but excludes system wide files.

    • Method Detail

      • values

        public static SystemFileKind[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (SystemFileKind c : SystemFileKind.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SystemFileKind valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getId

        public int getId()
        Returns:
        The internal backend id.

      • getWithDefault

        public boolean getWithDefault()
        Returns:
        get files include default tenant

      • getInstance

        public static SystemFileKind getInstance​(int id)
        Gets the instance matching to the id.
        Parameters:
        id - The internal backend id.
        Returns:
        The machting instance.