com.uc4.api.objects

Class SyncAction

java.lang.Object

com.uc4.api.objects.SyncAction

public class SyncAction
extends Object

This class represents an action of an Sync object.

Constructor Summary

Constructors

Constructor and Description
SyncAction(String action, String onState, String setState) Constructs a new SyncAction using the specified values.
SyncAction(String action, String onState, String checkOperator, int checkValue, String newState, String newValueOperator, int newValue) Constructs a new SyncAction using the specified values.

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of the action.
String	getNewOperator() Returns the operator which modifies the new value.
String	getNewState() Returns the name of the new state.
int	getNewValue() Returns the new value.
String	getOnOperator() Returns the comparison operator.
String	getOnState() Returns the comparison state.
int	getOnValue() Returns the comparison value.
void	setAction(String action) Sets the name of the action.
void	setNewOperator(String value) Sets the operator which modifies the new value.
void	setNewState(String newState) Sets the name of the new state.
void	setNewValue(int newValue) Sets the new Value.
void	setOnOperator(String op) Sets the comparison operator.
void	setOnState(String checkState) Sets the comparison state.
void	setOnValue(int value) Sets the comparison value.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SyncAction

public SyncAction(String action,
                  String onState,
                  String checkOperator,
                  int checkValue,
                  String newState,
                  String newValueOperator,
                  int newValue)

Constructs a new SyncAction using the specified values.

Parameters:

action - Name of the action

onState - The action may be taken only if the Sync object is in corresponding state.

checkOperator - The action can additionally be influenced by the value of a Sync object. Select a comparison operator here

checkValue - The action execution can additionally be dependent on the value of a Sync object. Input this value here.

newState - With an action, a state will also be assigned to a Sync object.

newValueOperator - With an action, a value can also be modified. Select an operator for this modification here.

newValue - With an action, a new value can also be assigned to a Sync object.

SyncAction

public SyncAction(String action,
                  String onState,
                  String setState)

Constructs a new SyncAction using the specified values.

Parameters:

action - Name of the action

onState - The action may be taken only if the Sync object is in corresponding state.

setState - With an action, a state will also be assigned to a Sync object.

Method Detail

getAction

public String getAction()

Returns the name of the action.

Returns:

Name of the action

setAction

public void setAction(String action)

Sets the name of the action. Max. 30 characters are allowed.

Parameters:

action - Name of the action

getOnOperator

public String getOnOperator()

Returns the comparison operator.

Returns:

Comparison operator

setOnOperator

public void setOnOperator(String op)

Sets the comparison operator.

Parameters:

op - Comparison operator

getOnState

public String getOnState()

Returns the comparison state.

Returns:

Comparison state

setOnState

public void setOnState(String checkState)

Sets the comparison state.

Parameters:

checkState - Comparison state

getOnValue

public int getOnValue()

Returns the comparison value.

Returns:

Comparison value

setOnValue

public void setOnValue(int value)

Sets the comparison value.

Parameters:

value - Comparison value

getNewState

public String getNewState()

Returns the name of the new state.

Returns:

Name of the new state.

setNewState

public void setNewState(String newState)

Sets the name of the new state.

Parameters:

newState - Name of the new state

getNewValue

public int getNewValue()

Returns the new value.

Returns:

Value

setNewValue

public void setNewValue(int newValue)

Sets the new Value.

Parameters:

newValue - Value

getNewOperator

public String getNewOperator()

Returns the operator which modifies the new value.

Returns:

Operator which modifies the new value.

setNewOperator

public void setNewOperator(String value)

Sets the operator which modifies the new value.

Parameters:

value - Operator which modifies the new value