Package com.uc4.api.objects
Class Sync
java.lang.Object
com.uc4.api.objects.UC4Object
com.uc4.api.objects.Sync
Sync object.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns an iterator overSyncAction
.int
Returns the number of defined actions.void
addAction
(SyncAction action) Adds a new action to this Sync object.void
Adds aSyncState
to this Sync object.Gets attributes of this Sync object.header()
Returns the header data of this object.boolean
Returnstrue
if this Object can be executed.protected void
loadContent
(com.uc4.util.XMLDocument doc, ConnectionAttributes info) boolean
removeAction
(SyncAction action) Removes the specified action.void
Method to remove all the actions.void
Method to remove all the states.boolean
removeState
(SyncState state) Removes the specifiedSyncState
.Returns an iterator overSyncState
.int
Returns the number of Sync states.protected void
storeContent
(com.uc4.util.XMLDocument doc, Element objectElement, ConnectionAttributes sessionInfo) void
validate()
Validates the object.Methods inherited from class com.uc4.api.objects.UC4Object
docu, getAccess, getIdnr, getModCount, getName, getObjectClient, getType, isOldVersion, load, store
-
Constructor Details
-
Sync
public Sync()
-
-
Method Details
-
loadContent
-
header
Returns the header data of this object. This is the information of the header tab in the dialog client.- Returns:
- header
-
attributes
Gets attributes of this Sync object.- Returns:
- Attributes of this Sync
-
stateIterator
Returns an iterator overSyncState
.- Returns:
- Iterator over
SyncState
-
addState
Adds aSyncState
to this Sync object.- Parameters:
state
- State which should be added
-
removeState
Removes the specifiedSyncState
.- 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
Returns an iterator overSyncAction
.- Returns:
- Iterator over
SyncAction
-
addAction
Adds a new action to this Sync object.- Parameters:
action
- Action which should be added
-
removeAction
Removes the specified action. An action can also be removed using the iterator returned from the methodactionIterator
.- 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
Description copied from class:UC4Object
Validates the object. If the object is not valid anInvalidObjectException
is thrown.- Overrides:
validate
in classUC4Object
- 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
Returnstrue
if this Object can be executed.- Specified by:
isExecutable
in classUC4Object
- Returns:
- true if the Object can be executed, false if not.
-