Class OutputTemplateFieldSynchronisationService

java.lang.Object

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

ch.tocco.nice2.reporting.impl.sync.OutputTemplateFieldSynchronisationService

All Implemented Interfaces:

SynchronisationService<OutputTemplateFieldContribution>

@Component
@Order(400)
public class OutputTemplateFieldSynchronisationService
extends AbstractSynchronisationService<OutputTemplateFieldContribution>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ORDER

Constructor Summary

Constructors

Constructor	Description
OutputTemplateFieldSynchronisationService(Context context, TextResources textResources, QueryBuilderFactory queryBuilderFactory, EntityDefaultValueService entityDefaultValueService)

Method Summary

Modifier and Type	Method	Description
Entity	createEntity(OutputTemplateFieldContribution description)	creates and entity using the given description
String	getEntityName()
void	initialiseEntity(Entity field, OutputTemplateFieldContribution description)	Initialises an entity using the given description.
Collection<OutputTemplateFieldContribution>	retrieveAllDescriptions()	retrieve all available descriptions
Iterable<Entity>	retrieveAllExternalEntities()	retrieves all external entities
Optional<OutputTemplateFieldContribution>	retrieveDescription(String identifier)	retrieve a description using an identifier
Optional<Entity>	retrieveEntity(OutputTemplateFieldContribution description)	retrieves the entity for a given description
String	retrieveIdentifier(Entity entity)	retrieve an identifier with whom the description can be distinguished
void	setOutputTemplateFieldSources(List<OutputTemplateFieldContributionsBuilder> outputTemplateFieldSources)
void	updateEntity(Entity field, OutputTemplateFieldContribution description)	updates the entity using the given description

Methods inherited from class AbstractSynchronisationService

getEdited, getExternal, resetEntity, setEdited, setExternal, synchronize

Methods inherited from class 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

OutputTemplateFieldSynchronisationService

public OutputTemplateFieldSynchronisationService(Context context,
 TextResources textResources,
 QueryBuilderFactory queryBuilderFactory,
 EntityDefaultValueService entityDefaultValueService)

Method Details

getEntityName

public String getEntityName()

retrieveEntity

public Optional<Entity> retrieveEntity(OutputTemplateFieldContribution 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<OutputTemplateFieldContribution> retrieveDescription(String identifier)

Description copied from interface: SynchronisationService

retrieve a description using an identifier

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

Overrides:

retrieveIdentifier in class AbstractSynchronisationService<OutputTemplateFieldContribution>

retrieveAllDescriptions

public Collection<OutputTemplateFieldContribution> retrieveAllDescriptions()

Description copied from interface: SynchronisationService

retrieve all available descriptions

createEntity

public Entity createEntity(OutputTemplateFieldContribution description)
                    throws IOException

Description copied from interface: SynchronisationService

creates and entity using the given description

Throws:

IOException

initialiseEntity

public void initialiseEntity(Entity field,
 OutputTemplateFieldContribution 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 field,
 OutputTemplateFieldContribution description)
                  throws IOException

Description copied from interface: SynchronisationService

updates the entity using the given description

Throws:

IOException

setOutputTemplateFieldSources

@Autowired(required=false)
public void setOutputTemplateFieldSources(List<OutputTemplateFieldContributionsBuilder> outputTemplateFieldSources)