Package com.uc4.api.objects

Class SyncAction

  • public class SyncAction
extends java.lang.Object
    This class represents an action of an Sync object.

    • Constructor Summary

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

    • Method Summary

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

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SyncAction

        public SyncAction​(java.lang.String action,
                  java.lang.String onState,
                  java.lang.String checkOperator,
                  int checkValue,
                  java.lang.String newState,
                  java.lang.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​(java.lang.String action,
                  java.lang.String onState,
                  java.lang.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 java.lang.String getAction()
        Returns the name of the action.
        Returns:
        Name of the action

      • setAction

        public void setAction​(java.lang.String action)
        Sets the name of the action. Max. 30 characters are allowed.
        Parameters:
        action - Name of the action

      • getOnOperator

        public java.lang.String getOnOperator()
        Returns the comparison operator.
        Returns:
        Comparison operator

      • setOnOperator

        public void setOnOperator​(java.lang.String op)
        Sets the comparison operator.
        Parameters:
        op - Comparison operator

      • getOnState

        public java.lang.String getOnState()
        Returns the comparison state.
        Returns:
        Comparison state

      • setOnState

        public void setOnState​(java.lang.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 java.lang.String getNewState()
        Returns the name of the new state.
        Returns:
        Name of the new state.

      • setNewState

        public void setNewState​(java.lang.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 java.lang.String getNewOperator()
        Returns the operator which modifies the new value.
        Returns:
        Operator which modifies the new value.

      • setNewOperator

        public void setNewOperator​(java.lang.String value)
        Sets the operator which modifies the new value.
        Parameters:
        value - Operator which modifies the new value