Package com.uc4.api.objects
Class SyncAction
java.lang.Object
com.uc4.api.objects.SyncAction
This class represents an action of an Sync object.
-
Constructor Summary
ConstructorsConstructorDescriptionSyncAction
(String action, String onState, String setState) Constructs a newSyncAction
using the specified values.SyncAction
(String action, String onState, String checkOperator, int checkValue, String newState, String newValueOperator, int newValue) Constructs a newSyncAction
using the specified values. -
Method Summary
Modifier and TypeMethodDescriptionReturns the name of the action.Returns the operator which modifies the new value.Returns the name of the new state.int
Returns the new value.Returns the comparison operator.Returns the comparison state.int
Returns the comparison value.void
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.
-
Constructor Details
-
SyncAction
public SyncAction(String action, String onState, String checkOperator, int checkValue, String newState, String newValueOperator, int newValue) Constructs a newSyncAction
using the specified values.- Parameters:
action
- Name of the actiononState
- 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 herecheckValue
- 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
Constructs a newSyncAction
using the specified values.- Parameters:
action
- Name of the actiononState
- 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 Details
-
getAction
Returns the name of the action.- Returns:
- Name of the action
-
setAction
Sets the name of the action. Max. 30 characters are allowed.- Parameters:
action
- Name of the action
-
getOnOperator
Returns the comparison operator.- Returns:
- Comparison operator
-
setOnOperator
Sets the comparison operator.- Parameters:
op
- Comparison operator
-
getOnState
Returns the comparison state.- Returns:
- Comparison state
-
setOnState
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
Returns the name of the new state.- Returns:
- Name of the new state.
-
setNewState
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
Returns the operator which modifies the new value.- Returns:
- Operator which modifies the new value.
-
setNewOperator
Sets the operator which modifies the new value.- Parameters:
value
- Operator which modifies the new value
-