Package ch.tocco.nice2.reporting.impl.sync

Class OutputTemplateSynchronisationService

java.lang.Object

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

ch.tocco.nice2.reporting.impl.sync.OutputTemplateSynchronisationService

All Implemented Interfaces:

SynchronisationService<OutputTemplateContribution>

@Component
@Order(300)
public class OutputTemplateSynchronisationService
extends AbstractSynchronisationService<OutputTemplateContribution>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ORDER

Constructor Summary

Constructors

Constructor	Description
OutputTemplateSynchronisationService(Context context, TextResources textResources, QueryBuilderFactory queryBuilderFactory, EntityDefaultValueService entityDefaultValueService, EntityDocumentsService entityDocumentsService, ContentTreeService contentTreeService, BinaryFactory binaryFactory, SynchronisationManager synchronisationManager)

Method Summary

Modifier and Type	Method	Description
Entity	createEntity(OutputTemplateContribution description)	creates and entity using the given description
String	getEntityName()
void	initialiseEntity(Entity outputTemplate, OutputTemplateContribution description)	Initialises an entity using the given description.
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
Collection<OutputTemplateContribution>	retrieveAllDescriptions()	retrieve all available descriptions
Iterable<Entity>	retrieveAllExternalEntities()	retrieves all external entities
Optional<OutputTemplateContribution>	retrieveDescription(String uniqueId)	retrieve a description using an identifier
Optional<Entity>	retrieveEntity(OutputTemplateContribution description)	retrieves the entity for a given description
void	setOutputTemplateSources(List<OutputTemplateContributionsBuilder> outputTemplateSources)
void	updateEntity(Entity outputTemplate, OutputTemplateContribution description)	updates the entity using the given description

Methods inherited from class ch.tocco.nice2.synchronisation.api.AbstractSynchronisationService

getEdited, getExternal, retrieveIdentifier, setEdited, setExternal, synchronize

Methods inherited from class java.lang.Object

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

Field Details

ORDER

public static final int ORDER

See Also:

• Constant Field Values

Constructor Details

OutputTemplateSynchronisationService

public OutputTemplateSynchronisationService(Context context,
 TextResources textResources,
 QueryBuilderFactory queryBuilderFactory,
 EntityDefaultValueService entityDefaultValueService,
 EntityDocumentsService entityDocumentsService,
 ContentTreeService contentTreeService,
 BinaryFactory binaryFactory,
 @Lazy
 SynchronisationManager synchronisationManager)

Method Details

getEntityName

public String getEntityName()

retrieveEntity

public Optional<Entity> retrieveEntity(OutputTemplateContribution description)

Description copied from interface: SynchronisationService

retrieves the entity for a given description

retrieveAllExternalEntities

public Iterable<Entity> retrieveAllExternalEntities()

Description copied from interface: SynchronisationService

retrieves all external entities

retrieveDescription

public Optional<OutputTemplateContribution> retrieveDescription(String uniqueId)

Description copied from interface: SynchronisationService

retrieve a description using an identifier

retrieveAllDescriptions

public Collection<OutputTemplateContribution> retrieveAllDescriptions()

Description copied from interface: SynchronisationService

retrieve all available descriptions

createEntity

public Entity createEntity(OutputTemplateContribution description)
                    throws IOException

Description copied from interface: SynchronisationService

creates and entity using the given description

Throws:

IOException

initialiseEntity

public void initialiseEntity(Entity outputTemplate,
 OutputTemplateContribution description)
                      throws IOException

Description copied from interface: SynchronisationService

Initialises an entity using the given description. This method sets fields that may be edited without breaking synchronisation. It is called when creating or reseting an entity.

Throws:

IOException

updateEntity

public void updateEntity(Entity outputTemplate,
 OutputTemplateContribution description)
                  throws IOException

Description copied from interface: SynchronisationService

updates the entity using the given description

Throws:

IOException

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<OutputTemplateContribution>

Overrides:

resetEntity in class AbstractSynchronisationService<OutputTemplateContribution>

Throws:

IOException

setOutputTemplateSources

@Autowired
public void setOutputTemplateSources(List<OutputTemplateContributionsBuilder> outputTemplateSources)