CheckFileCondition (java-api 21.0.12 API)

java.lang.Object
- com.uc4.api.objects.ConditionOrAction
- - com.uc4.api.objects.CheckFileCondition

All Implemented Interfaces:

Condition
```
public class CheckFileCondition
extends ConditionOrAction
implements Condition
```
Checks if a file exists. Note: No stability check.

Field Summary
- Fields inherited from class com.uc4.api.objects.ConditionOrAction
  PAR0, PAR1, PAR2, PAR3, params

Constructor Summary

Constructors
Constructor and Description

CheckFileCondition()
Creates a new CheckFileCondition.

Constructors
Constructor and Description
`CheckFileCondition()` Creates a new `CheckFileCondition`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addElse(ConditionOrAction item)` Adds a condition or action to the list of conditions/actions which should be executed when this condition is false.
`void`	`addWhen(ConditionOrAction item)` Adds a condition or action to the list of conditions/actions which should be executed when this condition is true.
`java.util.Iterator<ConditionOrAction>`	`elseIterator()` The returned iterator can be used to get the actions/conditions which are executed when this condition is false.
`int`	`elseSize()` Returns the number of action/conditions which should be executed when this condition is false.
`UC4HostName`	`getAgent()` Returns the name of the Agent.
`int`	`getDisplayMessageID()`
`java.lang.String`	`getFile()` Returns the name of the file.
`java.lang.String`	`getId()`
`UC4ObjectName`	`getLogin()` Returns the name of the Login object.
`int`	`getParameterMessageID()`
`int`	`getSkeletonMessageID()`
`boolean`	`isAction()`
`boolean`	`isAfterCondition()`
`boolean`	`isBeforeCondition()`
`boolean`	`isExists()` Returns the exists property.
`boolean`	`isIF()`
`void`	`setAgent(UC4HostName agent)` Sets the name of the Agent.
`void`	`setExists(boolean exists)` Sets the exists property.
`void`	`setFile(java.lang.String file)` Sets the name of the File.
`void`	`setLogin(UC4ObjectName login)` Sets the name of the Login object that is used to check if the file exists.
`void`	`setOwnHost()` Sets *OWN as host .
`void`	`setOwnLogin()` Sets *OWN as Login object name .
`java.util.Iterator<ConditionOrAction>`	`whenIterator()` The returned iterator can be used to get the actions/conditions which are executed when this condition is true.
`int`	`whenSize()` Returns the number of action/conditions which should be executed when this condition is true.

Methods inherited from class com.uc4.api.objects.ConditionOrAction
copy, createActionFromId, createConditionFromId, equals, getParameter, getPromptName, getScriptName, hashCode, isActive, isOnce, isParameterAltView, setActive, setOnce, setParameter

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CheckFileCondition
```
public CheckFileCondition()
```
    Creates a new CheckFileCondition.
- Method Detail
  - setAgent
```
public void setAgent(UC4HostName agent)
```
    Sets the name of the Agent.
    
    Parameters:
    
    agent - Agent
  - setOwnHost
```
public void setOwnHost()
```
    Sets *OWN as host .
  - setFile
```
public void setFile(java.lang.String file)
```
    Sets the name of the File.
    
    Parameters:
    
    file - Filename
  - setExists
```
public void setExists(boolean exists)
```
    Sets the exists property.
    
    Parameters:
    
    exists - Exists
  - getAgent
```
public UC4HostName getAgent()
```
    Returns the name of the Agent.
    
    Returns:
    
    Agent or null if *OWN is used
  - getFile
```
public java.lang.String getFile()
```
    Returns the name of the file.
    
    Returns:
    
    filename
  - isExists
```
public boolean isExists()
```
    Returns the exists property.
    
    Returns:
    
    Exists
  - getLogin
```
public UC4ObjectName getLogin()
```
    Returns the name of the Login object.
    
    Returns:
    
    Login or null if *OWN is used
  - setLogin
```
public void setLogin(UC4ObjectName login)
```
    Sets the name of the Login object that is used to check if the file exists.
    
    Parameters:
    
    login - Login object name
  - setOwnLogin
```
public void setOwnLogin()
```
    Sets *OWN as Login object name .
  - isBeforeCondition
```
public boolean isBeforeCondition()
```
    Specified by:
    
    isBeforeCondition in interface Condition
    
    Specified by:
    
    isBeforeCondition in class ConditionOrAction
    
    Returns:
    
    true if the action/condition is allowed on the "Pre-Condition" tab
  - isAfterCondition
```
public boolean isAfterCondition()
```
    Specified by:
    
    isAfterCondition in interface Condition
    
    Specified by:
    
    isAfterCondition in class ConditionOrAction
    
    Returns:
    
    true if the action/condition is allowed on the "Post-Condition" tab
  - getId
```
public java.lang.String getId()
```
    Specified by:
    
    getId in interface Condition
    
    Specified by:
    
    getId in class ConditionOrAction
    
    Returns:
    
    ID of the condition or action
  - addWhen
```
public void addWhen(ConditionOrAction item)
```
    Description copied from interface: Condition
    
    Adds a condition or action to the list of conditions/actions which should be executed when this condition is true.
    
    Specified by:
    
    addWhen in interface Condition
    
    Parameters:
    
    item - Condition or Action
  - addElse
```
public void addElse(ConditionOrAction item)
```
    Description copied from interface: Condition
    
    Adds a condition or action to the list of conditions/actions which should be executed when this condition is false.
    
    Specified by:
    
    addElse in interface Condition
    
    Parameters:
    
    item - Condition or Action
  - whenSize
```
public int whenSize()
```
    Description copied from interface: Condition
    
    Returns the number of action/conditions which should be executed when this condition is true.
    
    Specified by:
    
    whenSize in interface Condition
    
    Returns:
    
    Number of conditions/actions
  - elseSize
```
public int elseSize()
```
    Description copied from interface: Condition
    
    Returns the number of action/conditions which should be executed when this condition is false.
    
    Specified by:
    
    elseSize in interface Condition
    
    Returns:
    
    Number of conditions/actions
  - whenIterator
```
public java.util.Iterator<ConditionOrAction> whenIterator()
```
    Description copied from interface: Condition
    
    The returned iterator can be used to get the actions/conditions which are executed when this condition is true. The remove() method of the java.util.Iterator can be used to remove conditions or actions.
    
    Specified by:
    
    whenIterator in interface Condition
    
    Returns:
    
    Iterator
  - elseIterator
```
public java.util.Iterator<ConditionOrAction> elseIterator()
```
    Description copied from interface: Condition
    
    The returned iterator can be used to get the actions/conditions which are executed when this condition is false. The remove() method of the java.util.Iterator can be used to remove conditions or actions.
    
    Specified by:
    
    elseIterator in interface Condition
    
    Returns:
    
    Iterator
  - isAction
```
public boolean isAction()
```
    Specified by:
    
    isAction in class ConditionOrAction
    
    Returns:
    
    true if the sub class is an instance of com.uc4.api.objects.Action or false if the sub class is an instance of com.uc4.api.objects.Condition
  - isIF
```
public boolean isIF()
```
    Specified by:
    
    isIF in class ConditionOrAction
    
    Returns:
    
    true if the action/condition is allowed in the condition of an IF workflow
  - getParameterMessageID
```
public int getParameterMessageID()
```
    Specified by:
    
    getParameterMessageID in class ConditionOrAction
    
    Returns:
    
    Message number of the parameter message
  - getSkeletonMessageID
```
public int getSkeletonMessageID()
```
    Specified by:
    
    getSkeletonMessageID in class ConditionOrAction
    
    Returns:
    
    Message number of this condition or action
  - getDisplayMessageID
```
public int getDisplayMessageID()
```
    Specified by:
    
    getDisplayMessageID in class ConditionOrAction
    
    Returns:
    
    Message number for displaying this condition

Class CheckFileCondition

Field Summary

Fields inherited from class com.uc4.api.objects.ConditionOrAction

Constructor Summary

Method Summary

Methods inherited from class com.uc4.api.objects.ConditionOrAction

Methods inherited from class java.lang.Object

Constructor Detail

CheckFileCondition

Method Detail

setAgent

setOwnHost

setFile

setExists

getAgent

getFile

isExists

getLogin

setLogin

setOwnLogin

isBeforeCondition

isAfterCondition

getId

addWhen

addElse

whenSize

elseSize

whenIterator

elseIterator

isAction

isIF

getParameterMessageID

getSkeletonMessageID

getDisplayMessageID