Package com.uc4.api.objects

Class FileSystem

java.lang.Object
com.uc4.api.objects.FileSystem
public class FileSystem extends Object
This class represents the "FileSystem" tab of an file event object.

  • Field Details

  • Constructor Details

    • FileSystem

      protected FileSystem(com.uc4.util.XMLDocument doc)

  • Method Details

    • setLogin

      public void setLogin(UC4ObjectName loginObject)
      Sets the name of the login object this field just effect on HostType WIN, UNIX Os/390 (MVS).
      Parameters:
      loginObject - login object

    • stableWithin

      public void stableWithin(int seconds)
      Adds an additional condition for the event: The file must be stable within the specified number of seconds.
      Parameters:
      seconds - Number of seconds

    • getWithinSeconds

      public int getWithinSeconds()
      Returns:
      Returns the number of seconds for an additional stable/changed critera

    • changedWithin

      public void changedWithin(int seconds)
      Adds an additional condition for the event: The file modification that must have changed within the specified amount of seconds.
      Parameters:
      seconds - Number of seconds

    • hasAdditionalStableCondition

      public boolean hasAdditionalStableCondition()
      Returns:
      true if the additional FILE_STABLE condition has been set.

    • hasAdditionalChangedCondition

      public boolean hasAdditionalChangedCondition()
      Returns:
      true if the additional FILE_CHANGED condition has been set.

    • removeAdditionalConditions

      public void removeAdditionalConditions()
      Removes additional FILE_STABLE/FILE_CHANGED conditions. This is the same as selecting an empty entry in the Dropdownbox in the GUI.

    • store

      protected void store(com.uc4.util.XMLDocument doc, Element request)

    • isConsiderAll

      public boolean isConsiderAll()
      Returns:
      true if all files should be considered, false otherwise

    • setConsiderAll

      public void setConsiderAll(boolean considerAll)
      Sets a flag that which is used to determine if all files should be considered in the check or not.
      Parameters:
      considerAll - true if all files should be considered, false otherwise

    • getUnit

      public String getUnit()
      Returns:
      Unit

    • setUnit

      public void setUnit(String unit)
      Sets the unit of the value. The parameter unit can contain the following values:
      • bytes
      • KB
      • MB
      • GB
      • TB
      • HostSpecific
      Parameters:
      unit - Unit

    • isStartupEvent

      public boolean isStartupEvent()
      Returns:
      Startup Event setting if the Host type is "MVS".

    • setStartupEvent

      public void setStartupEvent(boolean startupEvent)
      Parameters:
      startupEvent - Startup Event setting if the Host type is "MVS".

    • isInclSubDir

      public boolean isInclSubDir()
      Returns:
      true if sub directories should be included

    • setInclSubDir

      public void setInclSubDir(boolean inclSubDir)
      Enables or disables the search in sub directories.
      Parameters:
      inclSubDir - true if sub directories should be considered

    • getValue

      public long getValue()
      Returns:
      The current value

    • setValue

      public void setValue(long value)
      Sets the current value.
      Parameters:
      value - positive Number

    • getOperator

      public String getOperator()
      Returns the operator. This is one of the constants defined in this class which start with OPERATOR.
      Returns:
      Operator

    • setOperator

      public void setOperator(String operator)
      Sets the operator. The parameter operator must be one of the OPERATOR* constants defined in this class.
      Parameters:
      operator - Operator

    • getFileType

      public String getFileType()
      Returns the file type. The returned value is equal to one of the public constants defined in this class
      • FILE_NONE
      • PATH_SPACE_UNUSED
      • PATH_FILE_COUNT
      • FILESYSTEM_SPACE_FREE
      • PATH_SPACE_USED
      • FILE_SIZE
      Returns:
      File type

    • setFileType

      public void setFileType(String fileType)
      Sets the file type. The parameter fileType must be one of the constants defined in this class:
      • FILE_NONE
      • PATH_SPACE_UNUSED
      • PATH_FILE_COUNT
      • PATH_SPACE_USED
      • FILESYSTEM_SPACE_FREE
      • PATH_SPACE_USED
      • FILE_SIZE
      Parameters:
      fileType - File type

    • getPath

      public String getPath()
      Returns:
      Returns the Path

    • setPath

      public void setPath(String path)
      Sets the path.
      Parameters:
      path - Path

    • setHost

      public void setHost(UC4HostName host, String hostType)
      Sets the Agent for this Event.
      Parameters:
      host - Host
      hostType - Type of the host (for example WINDOWS)

    • getHost

      public UC4HostName getHost()
      Returns the name of the Agent for this FileEvent.
      Returns:
      host

    • getLogin

      public UC4ObjectName getLogin()
      Returns the name of the login object assigned "FileSystem" tab of an file event object.
      Returns:
      login object

    • isExecuteAfterScheduledTime

      public boolean isExecuteAfterScheduledTime()
      Returns:
      True if the event should be started after the scheduled time

    • setExecuteAfterScheduledTime

      public void setExecuteAfterScheduledTime(boolean executeAfterScheduledTime)
      Defines if the event should start after the scheduled time.
      Parameters:
      executeAfterScheduledTime - True if the event should be started after the scheduled time

    • isFirstExecutionAfterExpire

      public boolean isFirstExecutionAfterExpire()
      Returns:
      True if the first execution should be done after time is expired

    • isFirstExecutionImmediately

      public boolean isFirstExecutionImmediately()
      Returns:
      True if the first execution should be done immediately

    • setFirstExecutionImmediately

      public void setFirstExecutionImmediately()
      Sets the first execution immediately.

    • setFirstExecutionAfterExpire

      public void setFirstExecutionAfterExpire()
      Sets the first execution after time is expired .

    • setExecutionTypeRepeated

      public void setExecutionTypeRepeated()
      Sets the execution type to repeated.

    • isExecutionTypeRepeated

      public boolean isExecutionTypeRepeated()
      Returns:
      True if the execution type is repeated

    • setExecutionTypeSingle

      public void setExecutionTypeSingle()
      Sets the execution type to single.

    • isExecutionTypeSingle

      public boolean isExecutionTypeSingle()
      Returns:
      True if the execution type is set to single

    • setExecutionTypeUntilFirstHit

      public void setExecutionTypeUntilFirstHit()
      Sets the execution type to "Until first hit".

    • isExecutionTypeUntilFirstHit

      public boolean isExecutionTypeUntilFirstHit()
      Returns:
      True if the execution type is set to "Until first hit"

    • isTimerControlInterval

      public boolean isTimerControlInterval()
      Returns:
      True if the Event is executed in a defined interval

    • setTimerControlInterval

      public void setTimerControlInterval(int interval)
      Sets the polling interval in minutes.
      Parameters:
      interval - Interval in minutes

    • setTimerControlAuto

      public void setTimerControlAuto()
      Sets the TimeControl to Auto.

    • isTimerControlAuto

      public boolean isTimerControlAuto()
      Returns:
      true if Timer is Auto

    • getTimerControlMinutes

      public int getTimerControlMinutes()
      Returns the interval in minutes.
      Returns:
      Timer Interval in minutes

    • isTimerControlStartTime

      public boolean isTimerControlStartTime()
      Returns:
      True if the Event is set to be executed at a defined time

    • getTimerControlStartTime

      public Time getTimerControlStartTime()
      Gets the start time of the event.
      Returns:
      Start time

    • setTimerControlStartTime

      public void setTimerControlStartTime(Time start)
      Sets the start time of the event.
      Parameters:
      start - Start time

    • getHostType

      public String getHostType()
      Returns the Host type value
      Returns:
      hostType