de.xima.fc.importer.interfaces

Interface IEntityImportStager

All Known Implementing Classes:

ActionImportStager, ClientResourceImportStager, DataSourceImportStager, FormVersionImportStager, InboxImportStager, ProjectDoiDataImportStager, ProjectImportStager, ProjectInviteDataImportStager, ProjectResourceImportStager, StateImportStager, TemplateImportStager, UserGroupImportStager, UserImportStager, UserRoleImportStager

public interface IEntityImportStager

Common interface for entity import stagers. Stagers set up the given entities along with their configuration for import. The entity will not actually be imported/persisted. This step should be done later.

Author:

XIMA MEDIA GmbH, Dresden - Norman Lorenz - 18.06.2019

Method Summary

Modifier and Type	Method and Description
de.xima.cmn.dao.interfaces.IEntity<Long>	getEntity()
boolean	isEntityExists()
IEntityImportStager	override(boolean override) Sets whether or not already existing entities should be overridden
default IEntityImportStager	setPersisted(de.xima.cmn.dao.interfaces.IEntity<Long> persisted)
void	stage(IEntityContext ec) Stages the import for execution based on the given configuration

Method Detail

override

IEntityImportStager override(boolean override)

Sets whether or not already existing entities should be overridden

Parameters:

override - Boolean override entity

Returns:

IEntityImportStager for fluent builder use of importer

stage

void stage(IEntityContext ec)
    throws Exception

Stages the import for execution based on the given configuration

Parameters:

ec - IEntityContext to be used

Throws:

Exception

getEntity

de.xima.cmn.dao.interfaces.IEntity<Long> getEntity()

Returns:

IEntity that shall be imported

isEntityExists

boolean isEntityExists()

Returns:

whether or not the entity exists in the system

setPersisted

default IEntityImportStager setPersisted(de.xima.cmn.dao.interfaces.IEntity<Long> persisted)

Parameters:

persisted - IEntity that will be overridden if the importer is set to override. This method can be use to set the entity that should be overridden to a different one than the one that is select by UUID.