Package org.ametys.plugins.odfsync.apogee.scc.impl

Class CourseSynchronizableContentsCollection

java.lang.Object

org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSimpleSynchronizableContentsCollection

org.ametys.plugins.odfsync.apogee.scc.AbstractApogeeSynchronizableContentsCollection

org.ametys.plugins.odfsync.apogee.scc.AbstractApogeeSynchronizableContentsWithCatalogCollection

org.ametys.plugins.odfsync.apogee.scc.impl.CourseSynchronizableContentsCollection

All Implemented Interfaces:

SynchronizableContentsCollection, ApogeeSynchronizableContentsCollection, Configurable, Contextualizable, Serviceable

public class CourseSynchronizableContentsCollection
extends AbstractApogeeSynchronizableContentsWithCatalogCollection

SCC for course contents.

Field Summary

Fields

Modifier and Type	Field	Description
protected OdfReferenceTableHelper	_odfRefTableHelper	The ODF reference table helper
protected ShareableCourseHelper	_shareableCourseHelper	The shareable course helper
static String	MODEL_ID	SCC model id

Fields inherited from class org.ametys.plugins.odfsync.apogee.scc.AbstractApogeeSynchronizableContentsWithCatalogCollection

_catalogsManager

Fields inherited from class org.ametys.plugins.odfsync.apogee.scc.AbstractApogeeSynchronizableContentsCollection

__PARAM_COLUMNS, __PARAM_COLUMNS_COLUMN, __PARAM_CRITERIA, __PARAM_CRITERIA_CRITERION, __PARAM_CRITERIA_CRITERION_ID, __PARAM_CRITERIA_CRITERION_LABEL, __PARAM_CRITERIA_CRITERION_TYPE, __PARAM_ID_COLUMN, __PARAM_MAPPING, __PARAM_MAPPING_ATTRIBUTE, __PARAM_MAPPING_METADATA_REF, __PARAM_MAPPING_SYNCHRO, _apogeeDAO, _apogeeSCCHelper, _columns, _context, _criteria, _extFields, _idColumn, _jsonUtils, _mapping, _odfHelper, _odfLang, _sccDAO, _syncFields, PARAM_ADD_UNEXISTING_CHILDREN, PARAM_DATASOURCE_ID, PARAM_YEAR

Fields inherited from class org.ametys.plugins.contentio.synchronize.AbstractSimpleSynchronizableContentsCollection

_contentHelper, _synchronizingContentOperatorEP

Fields inherited from class org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

_contentTypeEP, _currentUserProvider, _hasGlobalError, _i18nUtils, _nbCreatedContents, _nbDeletedContents, _nbError, _nbNotChangedContents, _nbSynchronizedContents, _observationManager, _synchroComponent, SCC_UNIQUE_ID

Fields inherited from class org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection

_contentDAO, _contentPrefix, _contentType, _id, _initialActionId, _label, _languages, _modelId, _modelParamValues, _removalSync, _reportMails, _resolver, _restrictedField, _sccHelper, _searchModelConfiguration, _synchronizeActionId, _synchronizeExistingContentsOnly, _synchronizingContentOperator, _validateActionId, _validateAfterImport, _workflowName

Fields inherited from interface org.ametys.plugins.contentio.synchronize.SynchronizableContentsCollection

COLLECTION_ID_PROPERTY

Constructor Summary

Constructors

Constructor	Description
CourseSynchronizableContentsCollection()

Method Summary

Modifier and Type	Method	Description
protected List<Map<String,Object>>	_search(Map<String,Object> searchParams, org.slf4j.Logger logger)	Search the contents with the search parameters.
protected boolean	additionalImportOperations(ModifiableDefaultContent content, Map<String,List<Object>> remoteValues, Map<String,Object> importParams, org.slf4j.Logger logger)	Add specific fields to the content.
protected String	getChildrenInvertMetadataName()	Get the metadata name to get parent from children
protected String	getChildrenMetadataName()	Get the metadata name to get children
protected String	getChildrenSCCModelId()	Get the children SCC model id.
protected String	getMappingName()	Get the name of the mapping.
protected boolean	handleChildren(ModifiableDefaultContent content, boolean create, org.slf4j.Logger logger)	Set the children metadata and invert relation, import and synchronize the children too.
protected boolean	handleParent(ModifiableDefaultContent currentContent, ModifiableDefaultContent parentContent, org.slf4j.Logger logger)	Set the parent metadata and invert relation.
protected boolean	importCourseParts(ModifiableDefaultContent content, org.slf4j.Logger logger)	Set the course parts of the current Course.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.plugins.odfsync.apogee.scc.AbstractApogeeSynchronizableContentsWithCatalogCollection

_getExpressionsList, _handleAdditionalMetadata

Methods inherited from class org.ametys.plugins.odfsync.apogee.scc.AbstractApogeeSynchronizableContentsCollection

_addUnexistingChildren, _convertBigDecimal, _convertBigDecimal, _fillContent, _fillRichTexts, _getChildrenRemoteSyncCode, _getSort, _importChildren, _importContent, _importOrSynchronizeContent, _importUnexistingChildren, _internalPopulate, _isChildWillBeRemoved, _resetChildren, _setRichTextValue, _synchronizeChildren, _synchronizeContent, _transformClobToString, _transformListOfMap2MapOfList, additionalCommonOperations, addUnexistingChildren, configureDataSource, configureSearchModel, contextualize, getClobColumns, getDataSourceId, getExternalOnlyFields, getIdColumn, getIdField, getLocalAndExternalFields, getRemoteValues, getRichTextFields, getTotalCount, getYear, handleRightAssignmentContext, importContent, importOrSynchronizeChildren, importOrSynchronizeContents, internalSearch, populate, putIdParameter, setAdditionalMetadata, synchronizeContent

Methods inherited from class org.ametys.plugins.contentio.synchronize.AbstractSimpleSynchronizableContentsCollection

_getContentsToRemove, _getIdFieldValue, _handleContent, _importOrSynchronizeContent, _importOrSynchronizeContents, _isHandled, additionalSynchronizeOperations, configure, createContentAction, getContent, getTransformedRemoteValues, search, updateSyncInformations, validateContent

Methods inherited from class org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

_deleteContents, _getContentPathQuery, _getMetadataHolder, _isParamNotEmpty, _removeEmptyParameters, _removeMetadataIfExists, _synchronizeMetadata, _updateRelation, _updateRelation, applyChanges, applyChanges, createContentAction, deleteUnexistingContents, empty, sendErrorMail, updateSCCProperty, validateContent

Methods inherited from class org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection

_parseLanguages, _parseParameters, configureStaticParams, getContentPrefix, getContentType, getId, getInitialActionId, getLabel, getLanguages, getParameterValues, getReportMails, getRestrictedField, getSearchModelConfiguration, getSynchronizeActionId, getSynchronizeCollectionModelId, getSynchronizingContentOperator, getValidateActionId, getWorkflowName, removalSync, synchronizeExistingContentsOnly, validateAfterImport

Methods inherited from class java.lang.Object

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

Field Detail

MODEL_ID

public static final String MODEL_ID

SCC model id

See Also:

Constant Field Values

_odfRefTableHelper

protected OdfReferenceTableHelper _odfRefTableHelper

The ODF reference table helper

_shareableCourseHelper

protected ShareableCourseHelper _shareableCourseHelper

The shareable course helper

Constructor Detail

CourseSynchronizableContentsCollection

public CourseSynchronizableContentsCollection()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractApogeeSynchronizableContentsWithCatalogCollection

Throws:

ServiceException

_search

protected List<Map<String,Object>> _search(Map<String,Object> searchParams,
                                                 org.slf4j.Logger logger)

Description copied from class: AbstractApogeeSynchronizableContentsCollection

Search the contents with the search parameters. Use id parameter to search an unique content.

Specified by:

_search in class AbstractApogeeSynchronizableContentsCollection

Parameters:

searchParams - Search parameters

logger - The logger

Returns:

A Map of mapped metadatas extract from Apogée database ordered by content unique Apogée ID

getMappingName

protected String getMappingName()

Description copied from class: AbstractApogeeSynchronizableContentsCollection

Get the name of the mapping.

Specified by:

getMappingName in class AbstractApogeeSynchronizableContentsCollection

Returns:

the mapping name

additionalImportOperations

protected boolean additionalImportOperations(ModifiableDefaultContent content,
                                             Map<String,List<Object>> remoteValues,
                                             Map<String,Object> importParams,
                                             org.slf4j.Logger logger)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Add specific fields to the content.

Overrides:

additionalImportOperations in class AbstractSimpleSynchronizableContentsCollection

Parameters:

content - Content to update

remoteValues - Values of the content

importParams - Import parameters

logger - The logger

Returns:

true if there are changes

handleParent

protected boolean handleParent(ModifiableDefaultContent currentContent,
                               ModifiableDefaultContent parentContent,
                               org.slf4j.Logger logger)

Description copied from class: AbstractApogeeSynchronizableContentsCollection

Set the parent metadata and invert relation.

Overrides:

handleParent in class AbstractApogeeSynchronizableContentsCollection

Parameters:

currentContent - Current content

parentContent - Parent content to set

logger - The logger

Returns:

true if there are changes

handleChildren

protected boolean handleChildren(ModifiableDefaultContent content,
                                 boolean create,
                                 org.slf4j.Logger logger)

Description copied from class: AbstractApogeeSynchronizableContentsCollection

Set the children metadata and invert relation, import and synchronize the children too.

Overrides:

handleChildren in class AbstractApogeeSynchronizableContentsCollection

Parameters:

content - Current content

create - true if the content has been newly created

logger - The logger

Returns:

true if there are changes

getChildrenSCCModelId

protected String getChildrenSCCModelId()

Description copied from class: AbstractApogeeSynchronizableContentsCollection

Get the children SCC model id. Can be null if no implementation is defined.

Overrides:

getChildrenSCCModelId in class AbstractApogeeSynchronizableContentsCollection

Returns:

the children SCC model id

getChildrenMetadataName

protected String getChildrenMetadataName()

Description copied from class: AbstractApogeeSynchronizableContentsCollection

Get the metadata name to get children

Specified by:

getChildrenMetadataName in class AbstractApogeeSynchronizableContentsCollection

Returns:

the metadata name to get children

getChildrenInvertMetadataName

protected String getChildrenInvertMetadataName()

Description copied from class: AbstractApogeeSynchronizableContentsCollection

Get the metadata name to get parent from children

Specified by:

getChildrenInvertMetadataName in class AbstractApogeeSynchronizableContentsCollection

Returns:

the metadata name to get parent from children

importCourseParts

protected boolean importCourseParts(ModifiableDefaultContent content,
                                    org.slf4j.Logger logger)

Set the course parts of the current Course.

Parameters:

content - Current content

logger - The logger

Returns:

true if there are changes