com.uc4.api.objects

Class CurrentTimeCondition

java.lang.Object

com.uc4.api.objects.ConditionOrAction

com.uc4.api.objects.CurrentTimeCondition

All Implemented Interfaces:

Condition

public class CurrentTimeCondition
extends ConditionOrAction
implements Condition

Checks the (physical) time in the timezone the object was started in.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CurrentTimeCondition.When When operator.

Field Summary

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

PAR0, PAR1, PAR2, PAR3, params

Constructor Summary

Constructors

Constructor and Description
CurrentTimeCondition() Creates a new CurrentTimeCondition.

Method Summary

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.
int	getDisplayMessageID()
java.lang.String	getId()
int	getParameterMessageID()
int	getSkeletonMessageID()
Time	getTime()
CurrentTimeCondition.When	getWhen()
boolean	isAction()
boolean	isAfterCondition()
boolean	isBeforeCondition()
boolean	isIF()
void	setTime(Time time)
void	setWhen(CurrentTimeCondition.When when)
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

CurrentTimeCondition

public CurrentTimeCondition()

Creates a new CurrentTimeCondition.

Method Detail

setWhen

public void setWhen(CurrentTimeCondition.When when)

Parameters:

when - One of the enum constants BEFORE or AFTER

setTime

public void setTime(Time time)

Parameters:

time - Time which should be checked

getWhen

public CurrentTimeCondition.When getWhen()

Returns:

Operator for compare

getTime

public Time getTime()

Returns:

Time which should be checked

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