com.almworks.jira.structure.api.sync

Interface UndoingSynchronizer

All Superinterfaces:

StructureSynchronizer

public interface UndoingSynchronizer
extends StructureSynchronizer

A StructureSynchronizer that is able to undo synchronizer actions. To enable a synchronizer for undoing actions, the actions that are applied during StructureSynchronizer.sync(com.almworks.jira.structure.api.sync.SyncInstance, com.almworks.jira.structure.api.sync.IncrementalSyncData, com.almworks.jira.structure.api.forest.ForestSource) or StructureSynchronizer.resync(com.almworks.jira.structure.api.sync.SyncInstance, com.almworks.jira.structure.api.forest.ForestSource) should be recorded in SyncAuditLog. The synchronizer that implements this interface will then receive these actions in the same format in undo(java.util.List<com.almworks.jira.structure.api.util.MapObject>). It is up to the synchronizer author to supply sufficient information for undo in the actions recorded in SyncAuditLog.

Author:

sank

Field Summary

Fields

Modifier and Type	Field and Description
static String	FAILURE_REASON_UNKNOWN_ACTION

Method Summary

Modifier and Type	Method and Description
List<MapObject>	undo(List<MapObject> actions) Undoes the specified actions, performing zero or more undo actions.

Methods inherited from interface StructureSynchronizer

addDefaultFormParameters, addFormParameters, buildParametersFromForm, getConfigDescription, getConfigDescriptionDetails, getDescriptor, getPossibleResyncEffects, isAutosyncSupported, isAvailable, restoreParameters, resync, storeParameters, sync

Field Detail

FAILURE_REASON_UNKNOWN_ACTION

static final String FAILURE_REASON_UNKNOWN_ACTION

See Also:

Constant Field Values

Method Detail

undo

List<MapObject> undo(List<MapObject> actions)

Undoes the specified actions, performing zero or more undo actions. Returns the performed undo actions. They should be in the same format as the specified actions.