Package com.uc4.api.objects
Class CheckFileCondition
java.lang.Object
com.uc4.api.objects.ConditionOrAction
com.uc4.api.objects.CheckFileCondition
- All Implemented Interfaces:
Condition
Checks if a file exists.
Note: No stability check.
-
Field Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
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.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.getAgent()
Returns the name of the Agent.int
getFile()
Returns the name of the file.getId()
getLogin()
Returns the name of the Login object.int
int
boolean
isAction()
boolean
boolean
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
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
Sets *OWN as host .void
Sets *OWN as Login object name .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
-
Constructor Details
-
CheckFileCondition
public CheckFileCondition()Creates a newCheckFileCondition
.
-
-
Method Details
-
setAgent
Sets the name of the Agent.- Parameters:
agent
- Agent
-
setOwnHost
public void setOwnHost()Sets *OWN as host . -
setFile
Sets the name of the File.- Parameters:
file
- Filename
-
setExists
public void setExists(boolean exists) Sets the exists property.- Parameters:
exists
- Exists
-
getAgent
Returns the name of the Agent.- Returns:
- Agent or
null
if *OWN is used
-
getFile
Returns the name of the file.- Returns:
- filename
-
isExists
public boolean isExists()Returns the exists property.- Returns:
- Exists
-
getLogin
Returns the name of the Login object.- Returns:
- Login or
null
if *OWN is used
-
setLogin
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 interfaceCondition
- Specified by:
isBeforeCondition
in classConditionOrAction
- Returns:
- true if the action/condition is allowed on the "Pre-Condition" tab
-
isAfterCondition
public boolean isAfterCondition()- Specified by:
isAfterCondition
in interfaceCondition
- Specified by:
isAfterCondition
in classConditionOrAction
- Returns:
- true if the action/condition is allowed on the "Post-Condition" tab
-
getId
- Specified by:
getId
in interfaceCondition
- Specified by:
getId
in classConditionOrAction
- Returns:
- ID of the condition or action
-
addWhen
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. -
addElse
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. -
whenSize
public int whenSize()Description copied from interface:Condition
Returns the number of action/conditions which should be executed when this condition is true. -
elseSize
public int elseSize()Description copied from interface:Condition
Returns the number of action/conditions which should be executed when this condition is false. -
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 thejava.util.Iterator
can be used to remove conditions or actions.- Specified by:
whenIterator
in interfaceCondition
- Returns:
- Iterator
-
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 thejava.util.Iterator
can be used to remove conditions or actions.- Specified by:
elseIterator
in interfaceCondition
- Returns:
- Iterator
-
isAction
public boolean isAction()- Specified by:
isAction
in classConditionOrAction
- Returns:
- true if the sub class is an instance of
com.uc4.api.objects.Action
or false if the sub class is an instance ofcom.uc4.api.objects.Condition
-
isIF
public boolean isIF()- Specified by:
isIF
in classConditionOrAction
- Returns:
- true if the action/condition is allowed in the condition of an IF workflow
-
getParameterMessageID
public int getParameterMessageID()- Specified by:
getParameterMessageID
in classConditionOrAction
- Returns:
- Message number of the parameter message
-
getSkeletonMessageID
public int getSkeletonMessageID()- Specified by:
getSkeletonMessageID
in classConditionOrAction
- Returns:
- Message number of this condition or action
-
getDisplayMessageID
public int getDisplayMessageID()- Specified by:
getDisplayMessageID
in classConditionOrAction
- Returns:
- Message number for displaying this condition
-