Package ch.tocco.nice2.synchronisation.api

Class AbstractSynchronisationService<T extends SynchronisationDescription>

java.lang.Object

ch.tocco.nice2.synchronisation.api.AbstractSynchronisationService<T>

All Implemented Interfaces:

SynchronisationService<T>

Direct Known Subclasses:

BusinessUnitCorporateDesignSynchronisationService, CorporateDesignSynchronisationService, LabelContentSynchronisationService, LabelFormatSynchronisationService, LabelSynchronisationService, OutputTemplateFieldSynchronisationService, OutputTemplateLayoutSynchronisationService, OutputTemplateSynchronisationService, ReportSynchronisationService, TemplateSnippetSynchronisationService

public abstract class AbstractSynchronisationService<T extends SynchronisationDescription>
extends Object
implements SynchronisationService<T>

Constructor Summary

Constructors

Constructor	Description
AbstractSynchronisationService()

Method Summary

Modifier and Type	Method	Description
boolean	getEdited(Entity entity)	Returns the edited flag
boolean	getExternal(Entity entity)	Returns the external flag
void	resetEntity(Entity entity, List<String> options)	Resets the the entity using the unique_id of the given entity - if no description can be retrieved using the unique_id, the external flag is set to false - if a description can be retrieved, the entity is updated according to this description and the edited flag is set to false
String	retrieveIdentifier(Entity entity)	retrieve an identifier with whom the description can be distinguished
Entity	setEdited(Entity entity, boolean newValue)	Sets the edited flag on the given entity
Entity	setExternal(Entity entity, boolean newValue)	Sets the external flag on the given entity
void	synchronize()	retrieves all descriptions, loops over them and...

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.tocco.nice2.synchronisation.api.SynchronisationService

createEntity, getEntityName, initialiseEntity, retrieveAllDescriptions, retrieveAllExternalEntities, retrieveDescription, retrieveEntity, updateEntity

Constructor Details

AbstractSynchronisationService

public AbstractSynchronisationService()

Method Details

synchronize

public void synchronize()
                 throws IOException

Description copied from interface: SynchronisationService

retrieves all descriptions, loops over them and... ... creates non-existent entities (identified by unique_id) ... updates existing entities that have not been edited (external = true and edited = false) ... removes the external flag from entities if no description exists for it

Specified by:

synchronize in interface SynchronisationService<T extends SynchronisationDescription>

Throws:

IOException

retrieveIdentifier

public String retrieveIdentifier(Entity entity)

Description copied from interface: SynchronisationService

retrieve an identifier with whom the description can be distinguished

Specified by:

retrieveIdentifier in interface SynchronisationService<T extends SynchronisationDescription>

resetEntity

public void resetEntity(Entity entity,
 List<String> options)
                 throws IOException

Description copied from interface: SynchronisationService

Resets the the entity using the unique_id of the given entity - if no description can be retrieved using the unique_id, the external flag is set to false - if a description can be retrieved, the entity is updated according to this description and the edited flag is set to false

Specified by:

resetEntity in interface SynchronisationService<T extends SynchronisationDescription>

Throws:

IOException

setEdited

public Entity setEdited(Entity entity,
 boolean newValue)

Description copied from interface: SynchronisationService

Sets the edited flag on the given entity

Specified by:

setEdited in interface SynchronisationService<T extends SynchronisationDescription>

getEdited

public boolean getEdited(Entity entity)

Description copied from interface: SynchronisationService

Returns the edited flag

Specified by:

getEdited in interface SynchronisationService<T extends SynchronisationDescription>

setExternal

public Entity setExternal(Entity entity,
 boolean newValue)

Description copied from interface: SynchronisationService

Sets the external flag on the given entity

Specified by:

setExternal in interface SynchronisationService<T extends SynchronisationDescription>

getExternal

public boolean getExternal(Entity entity)

Description copied from interface: SynchronisationService

Returns the external flag

Specified by:

getExternal in interface SynchronisationService<T extends SynchronisationDescription>