Package com.saperion.ngc.iform.field.defaultValue

Enum DefaultValues

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DefaultValues>
    public enum DefaultValues
extends java.lang.Enum<DefaultValues>
    Enumeration of available default value strings for IntelligentFields.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()
      Returns the string representing this DefaultValue as used in a mask (in lower-case).
      static DefaultValues valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DefaultValues[] 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, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • SYSDATE

        public static final DefaultValues SYSDATE
        SysDate system variable.

      • SYSTIME

        public static final DefaultValues SYSTIME
        SysTime system variable.

      • USERNAME

        public static final DefaultValues USERNAME
        UserName system variable.

      • FILENAME

        public static final DefaultValues FILENAME
        Filename without path.

      • FILEPATH

        public static final DefaultValues FILEPATH
        File path.

      • FILEFULLNAME

        public static final DefaultValues FILEFULLNAME
        Filename and path.

      • FILEDATE

        public static final DefaultValues FILEDATE
        Date of last change on file.

      • FILETEXT

        public static final DefaultValues FILETEXT
        Content of file as text.

      • FILETIME

        public static final DefaultValues FILETIME
        Time of last change on file.

      • FILESIZE

        public static final DefaultValues FILESIZE
        Size of file (bytes).

      • MACHINENAME

        public static final DefaultValues MACHINENAME
        Name of the current machine.

      • USERID

        public static final DefaultValues USERID
        User ID in hex.

      • NUMPAGES

        public static final DefaultValues NUMPAGES
        Pages of a document.

      • FORMATNAME

        public static final DefaultValues FORMATNAME
        Format of structured document.

      • DBNAME

        public static final DefaultValues DBNAME
        Name of the database table of a document.

      • USERFULLNAME

        public static final DefaultValues USERFULLNAME
        Fullname of the current user.

      • DOC_FOLDERPATH

        public static final DefaultValues DOC_FOLDERPATH
        Document's folderpath.

    • Method Detail

      • values

        public static DefaultValues[] 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 (DefaultValues c : DefaultValues.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static DefaultValues 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

      • toString

        public java.lang.String toString()
        Returns the string representing this DefaultValue as used in a mask (in lower-case).
        Overrides:
        toString in class java.lang.Enum<DefaultValues>
        Returns:
        string representation of thid DefaultValue
        See Also:
        Enum.toString()