Class JobPublishSetupFolder

  • All Implemented Interfaces:
    java.io.Serializable

    public class JobPublishSetupFolder
    extends JobPublishSetupItem
    The class represents the folders to transfer for use in a published job submission. You can specify whether to include files and folders.
    Since:
    2.4
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      JobPublishSetupFolder​(java.lang.String path)
      Constructor.
      JobPublishSetupFolder​(java.lang.String path, boolean includeFiles, boolean includeSubfolders)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      int hashCode()  
      boolean isIncludeFiles()
      Indicates whether to include files when transferring the folder.
      boolean isIncludeSubfolders()
      Indicates whether to include child folders when transferring the folder.
      void setIncludeFiles​(boolean includeFiles)
      Sets whether to include files when transferring the folder.
      void setIncludeSubfolders​(boolean includeSubfolders)
      Sets whether to include child folders when transferring the folder.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • JobPublishSetupFolder

        public JobPublishSetupFolder​(java.lang.String path)
        Constructor.
        Parameters:
        path - The path to the folder to transfer for the published job.
      • JobPublishSetupFolder

        public JobPublishSetupFolder​(java.lang.String path,
                                     boolean includeFiles,
                                     boolean includeSubfolders)
        Constructor.
        Parameters:
        path - The path to the folder to transfer for the published job.
        includeSubfolders - Indicates whether to include folders.
        includeFiles - Indicates whether to include files.
    • Method Detail

      • isIncludeFiles

        public boolean isIncludeFiles()
        Indicates whether to include files when transferring the folder.
        Returns:
        Indicates whether to include files.
      • setIncludeFiles

        public void setIncludeFiles​(boolean includeFiles)
        Sets whether to include files when transferring the folder. The default is false.
        Parameters:
        includeFiles - Indicates whether to include files.
      • isIncludeSubfolders

        public boolean isIncludeSubfolders()
        Indicates whether to include child folders when transferring the folder.
        Returns:
        Indicates whether to include child folders.
      • setIncludeSubfolders

        public void setIncludeSubfolders​(boolean includeSubfolders)
        Sets whether to include child folders when transferring the folder. The default is false.
        Parameters:
        includeSubfolders - Indicates whether to include child folders.