org.ametys.plugins.odfsync.cdmfr.components.impl

Class SCCImportCDMFrComponent

java.lang.Object

org.ametys.plugins.odfsync.cdmfr.components.AbstractImportCDMFrComponent

org.ametys.plugins.odfsync.cdmfr.components.impl.SCCImportCDMFrComponent

All Implemented Interfaces:

ImportCDMFrComponent, Initializable, Component, Configurable, Contextualizable, Serviceable

public class SCCImportCDMFrComponent
extends AbstractImportCDMFrComponent

Component to import a CDM-fr input stream in SCC context.

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.odfsync.cdmfr.components.AbstractImportCDMFrComponent

AbstractImportCDMFrComponent.ContentWorkflowDescription

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_collectionId The collectionID
protected boolean	_removalSync True if removal sync
protected boolean	_validateAfterImport Validate after import

Fields inherited from class org.ametys.plugins.odfsync.cdmfr.components.AbstractImportCDMFrComponent

_catalogsManager, _cdmFrSyncExtensionPoint, _cocoonContext, _contentPrefix, _contentTypeEP, _currentUserProvider, _domParser, _importedContents, _nbCreatedContents, _nbError, _nbNotChangedContents, _nbSynchronizedContents, _observationManager, _odfLang, _odfRefTableHelper, _resolver, _rootOUProvider, _shareableCourseHelper, _syncFieldsByContentType, _synchroComponent, _synchronizedContents, _TAG_CONTAINER, _TAG_COURSELIST, _TAG_COURSEPART, _TAG_PROGRAM, _TAG_SUBPROGRAM, _updatedContents, _xPathProcessor

Fields inherited from interface org.ametys.plugins.odfsync.cdmfr.components.ImportCDMFrComponent

ROLE

Constructor Summary

Constructors

Constructor and Description
SCCImportCDMFrComponent()

Method Summary

Modifier and Type	Method and Description
protected void	additionalOperationsBeforeSave(ModifiableDefaultContent content, Logger logger) Additional operation to do on the content before saving it.
protected void	additionalParameters(Map<String,Object> parameters) Additional parameters for specific treatments.
List<Expression>	getExpressionsList(String lang, String idValue, String contentType, String catalog) Construct the query to retrieve the content.
protected boolean	removalSync() When returns true, a content created by a previous synchro will be removed if it does not exist anymore during the current synchro.
protected boolean	validateAfterImport() True to validate the contents after import

Methods inherited from class org.ametys.plugins.odfsync.cdmfr.components.AbstractImportCDMFrComponent

_getContent, _getIdFromCDMThenCode, _getOrCreateContent, _handleBinaryMetadata, _handleBinaryMetadata, _handleFileMetadata, _handleFileMetadata, _handleGeocodeMetadata, _handleGeocodeMetadata, _handleMetadataValues, _importOrSynchronizeContent, _linkTranslationsIfExist, _saveContentChanges, _setChildren, _setOrgUnitParent, _setRelations, _synchronizeContent, _synchronizeCourseList, _synchronizeMetadata, configure, contextualize, getCatalogName, getContainerWfDescription, getCourseListWfDescription, getCoursePartWfDescription, getCourseWfDescription, getIdField, getLocalAndExternalFields, getOrgUnitWfDescription, getPersonWfDescription, getProgramWfDescription, getSubProgramWfDescription, handleInputStream, ignoreRights, initialize, service, transformDocument

Methods inherited from class java.lang.Object

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

Field Detail

_collectionId

protected String _collectionId

The collectionID

_validateAfterImport

protected boolean _validateAfterImport

Validate after import

_removalSync

protected boolean _removalSync

True if removal sync

Constructor Detail

SCCImportCDMFrComponent

public SCCImportCDMFrComponent()

Method Detail

additionalParameters

protected void additionalParameters(Map<String,Object> parameters)

Description copied from class: AbstractImportCDMFrComponent

Additional parameters for specific treatments.

Specified by:

additionalParameters in class AbstractImportCDMFrComponent

Parameters:

parameters - The parameters map to get

additionalOperationsBeforeSave

protected void additionalOperationsBeforeSave(ModifiableDefaultContent content,
                                              Logger logger)
                                       throws RepositoryException

Description copied from class: AbstractImportCDMFrComponent

Additional operation to do on the content before saving it.

Specified by:

additionalOperationsBeforeSave in class AbstractImportCDMFrComponent

Parameters:

content - The content

logger - The logger

Throws:

RepositoryException - if an error occurs

getExpressionsList

public List<Expression> getExpressionsList(String lang,
                                           String idValue,
                                           String contentType,
                                           String catalog)

Description copied from interface: ImportCDMFrComponent

Construct the query to retrieve the content.

Specified by:

getExpressionsList in interface ImportCDMFrComponent

Overrides:

getExpressionsList in class AbstractImportCDMFrComponent

Parameters:

lang - Lang

idValue - Synchronization value

contentType - Content type

catalog - The catalog

Returns:

The List of Expression

validateAfterImport

protected boolean validateAfterImport()

Description copied from class: AbstractImportCDMFrComponent

True to validate the contents after import

Specified by:

validateAfterImport in class AbstractImportCDMFrComponent

Returns:

True to validate the contents after import

removalSync

protected boolean removalSync()

Description copied from class: AbstractImportCDMFrComponent

When returns true, a content created by a previous synchro will be removed if it does not exist anymore during the current synchro.

Specified by:

removalSync in class AbstractImportCDMFrComponent

Returns:

true if a content created by a previous synchro has to be removed if it does not exist anymore during the current synchro.