Package com.uc4.api.objects

Class Sync

java.lang.Object
com.uc4.api.objects.UC4Object
com.uc4.api.objects.Sync
public class Sync extends UC4Object
Sync object.

  • Constructor Details

    • Sync

      public Sync()

  • Method Details

    • loadContent

      protected void loadContent(com.uc4.util.XMLDocument doc, ConnectionAttributes info)

    • header

      public XHeader header()
      Returns the header data of this object. This is the information of the header tab in the dialog client.
      Returns:
      header

    • attributes

      public SyncAttributes attributes()
      Gets attributes of this Sync object.
      Returns:
      Attributes of this Sync

    • stateIterator

      public Iterator<SyncState> stateIterator()
      Returns an iterator over SyncState.
      Returns:
      Iterator over SyncState

    • addState

      public void addState(SyncState state)
      Adds a SyncState to this Sync object.
      Parameters:
      state - State which should be added

    • removeState

      public boolean removeState(SyncState state)
      Removes the specified SyncState.
      Parameters:
      state - State which should be removed
      Returns:
      True if the action was removed successfully

    • stateSize

      public int stateSize()
      Returns the number of Sync states.
      Returns:
      Number of Sync states

    • actionIterator

      public Iterator<SyncAction> actionIterator()
      Returns an iterator over SyncAction.
      Returns:
      Iterator over SyncAction

    • addAction

      public void addAction(SyncAction action)
      Adds a new action to this Sync object.
      Parameters:
      action - Action which should be added

    • removeAction

      public boolean removeAction(SyncAction action)
      Removes the specified action. An action can also be removed using the iterator returned from the method actionIterator.
      Parameters:
      action - Action which should be removed
      Returns:
      True if the action was removed successfully

    • removeAllActions

      public void removeAllActions()
      Method to remove all the actions.

    • removeAllStates

      public void removeAllStates()
      Method to remove all the states.

    • actionSize

      public int actionSize()
      Returns the number of defined actions.
      Returns:
      Number of actions

    • validate

      public void validate() throws InvalidObjectException
      Description copied from class: UC4Object
      Validates the object. If the object is not valid an InvalidObjectException is thrown.
      Overrides:
      validate in class UC4Object
      Throws:
      InvalidObjectException - If the object is not valid

    • storeContent

      protected void storeContent(com.uc4.util.XMLDocument doc, Element objectElement, ConnectionAttributes sessionInfo)

    • isExecutable

      public boolean isExecutable()
      Description copied from class: UC4Object
      Returns true if this Object can be executed.
      Specified by:
      isExecutable in class UC4Object
      Returns:
      true if the Object can be executed, false if not.