Class LISFileSystemSettingsReferenceDTO

java.lang.Object
de.aeb.xnsg.vcp.bf.lis.LISFileSystemSettingsReferenceDTO
All Implemented Interfaces:
Serializable

public class LISFileSystemSettingsReferenceDTO extends Object implements Serializable
The reference to file system storage settings in the VCP
See Also:
  • Field Details

    • FILE_SYSTEM_REFERENCE_TYPE_ACTIVE

      public static final String FILE_SYSTEM_REFERENCE_TYPE_ACTIVE
      The reference type "ACTIVE".

      Finds the currently active document storage settings. If it is not a file system type, this will produce an error.

      See Also:
    • FILE_SYSTEM_REFERENCE_TYPE_ID

      public static final String FILE_SYSTEM_REFERENCE_TYPE_ID
      The reference type "ID".

      Finds the file system storage settings by internal ID. If none are found, this will produce an error. The ID has to be provided in the field referenceKey.

      Example: type="ID", referenceKey="2534167"

      See Also:
    • FILE_SYSTEM_REFERENCE_TYPE_PATH

      public static final String FILE_SYSTEM_REFERENCE_TYPE_PATH
      The reference type "PATH".

      Finds the file system storage settings by its starting path. If none are found, this will produce an error. The path has to be provided in the field referenceKey.

      Example: type="PATH", referenceKey="D:\Documents\"

      See Also:
    • type

      public String type
      A constant how the file system settings should be found. Its possible values are found in the FILE_SYSTEM_REFERENCE_TYPE constants. Possible values:
      • ACTIVE
      • ID
      • PATH
    • referenceKey

      public String referenceKey
      A reference key which will be utilized by the different types
  • Constructor Details

    • LISFileSystemSettingsReferenceDTO

      public LISFileSystemSettingsReferenceDTO()