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 final 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, _addExistingChildren, _addUnexistingChildren, _apogeeDAO, _apogeeSCCHelper, _columns, _context, _criteria, _idColumn, _jsonUtils, _mapping, _odfHelper, _odfLang, _sccDAO, _syncFields, PARAM_ADD_EXISTING_CHILDREN, 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

_contentWorkflowHelper, _currentUserProvider, _hasGlobalError, _i18nUtils, _nbCreatedContents, _nbDeletedContents, _nbError, _nbNotChangedContents, _nbSynchronizedContents, _observationManager, SCC_UNIQUE_ID

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

_contentDAO, _contentPrefix, _contentType, _contentTypeEP, _id, _ignoreRestrictions, _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_DATA_NAME, RESULT_NB_CREATED_CONTENTS, RESULT_NB_DELETED_CONTENTS, RESULT_NB_NOT_CHANGED_CONTENTS, RESULT_NB_SYNCHRONIZED_CONTENTS

Constructor Summary

Constructors

Constructor	Description
CourseSynchronizableContentsCollection()

Method Summary

Modifier and Type	Method	Description
protected void	_addEditInputsForSCC(Map<String,Object> inputs, WorkflowAwareContent content, Logger logger)	Add the inputs specific for the SCC to the inputs for edit content function.
protected List<Map<String,Object>>	_search(Map<String,Object> searchParameters, Logger logger)	Search the contents with the search parameters.
ContentSynchronizationResult	additionalImportOperations(ModifiableContent content, Map<String,Object> additionalParameters, Logger logger)	Add specific fields to the content.
protected Map<String,Object>	getAdditionalAttributeValues(String idValue, Content content, Map<String,Object> additionalParameters, boolean create, Logger logger)	Retrieves additional values to synchronize for a content
protected String	getChildrenAttributeName()	Get the attribute name to get children
protected String	getChildrenSCCModelId()	Get the children SCC model id.
protected String	getMappingName()	Get the name of the mapping.
protected Set<String>	getNotSynchronizedRelatedContentIds(Content content, Map<String,Object> contentValues, Map<String,Object> additionalParameters, String lang, Logger logger)	Retrieves the ids of the contents related to the given content but that are not part of the synchronization
protected Pair<String,Object>	getParentAttribute(ModifiableContent parent)	Retrieves the attribute to synchronize for the given parent (as a Pair of name and value)
protected List<ModifiableContent>	importCourseParts(Content course, Logger logger)	Creates the course parts of the current Course.
void	service(ServiceManager manager)

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

_getAdditionalInputsForContentCreation, _getExpressionsList

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

_convertBigDecimal, _convertBigDecimal, _getChildrenRemoteSyncCode, _getChildrenSearchParametersWithParent, _getSort, _importChildren, _importContent, _importUnexistingChildren, _internalPopulate, _isChildWillBeRemoved, _synchronizeChildren, _synchronizeContent, _transformClobToString, _transformListOfMap2MapOfList, addExistingChildren, addUnexistingChildren, configureDataSource, configureSearchModel, contextualize, getClobColumns, getDataSourceId, getIdColumn, getIdField, getLanguages, getLocalAndExternalFields, getParentFromAdditionalParameters, getParentIdFromAdditionalParameters, getRemoteValues, getTotalCount, getYear, handleChildren, handleRightAssignmentContext, importContent, importOrSynchronizeChildren, importOrSynchronizeContents, internalSearch, populate, putIdParameter, synchronizeContent

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

_editContent, _fillContent, _getContentsToRemove, _getEditInputs, _getEditInputsContextParameters, _handleContent, _importOrSynchronizeContent, _importOrSynchronizeContent, _importOrSynchronizeContents, _isHandled, _transformRemoteValues, configure, createContentAction, getContent, getTransformedRemoteValues, search, updateSyncInformations, validateContent

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

_deleteContents, _getContentPathQuery, _hasSomethingChanged, _isParamNotEmpty, _logSynchronizationResult, _removeEmptyParameters, createContentAction, deleteUnexistingContents, empty, getSynchronizationResult, sendErrorMail, validateContent

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

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

Methods inherited from class java.lang.Object

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

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

additionalCommonOperations, additionalSynchronizeOperations

Field Details

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 Details

CourseSynchronizableContentsCollection

public CourseSynchronizableContentsCollection()

Method Details

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> searchParameters,
 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:

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

getAdditionalAttributeValues

protected Map<String,Object> getAdditionalAttributeValues(String idValue,
 Content content,
 Map<String,Object> additionalParameters,
 boolean create,
 Logger logger)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Retrieves additional values to synchronize for a content

Overrides:

getAdditionalAttributeValues in class AbstractApogeeSynchronizableContentsCollection

Parameters:

idValue - id value of the content

content - The content

additionalParameters - Additional parameters

create - true if the content has been newly created, false otherwise

logger - The logger

Returns:

the values to add

getParentAttribute

protected Pair<String,Object> getParentAttribute(ModifiableContent parent)

Description copied from class: AbstractApogeeSynchronizableContentsCollection

Retrieves the attribute to synchronize for the given parent (as a Pair of name and value)

Overrides:

getParentAttribute in class AbstractApogeeSynchronizableContentsCollection

Parameters:

parent - the parent content

Returns:

the parent attribute

getNotSynchronizedRelatedContentIds

protected Set<String> getNotSynchronizedRelatedContentIds(Content content,
 Map<String,Object> contentValues,
 Map<String,Object> additionalParameters,
 String lang,
 Logger logger)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Retrieves the ids of the contents related to the given content but that are not part of the synchronization

Overrides:

getNotSynchronizedRelatedContentIds in class AbstractApogeeSynchronizableContentsCollection

Parameters:

content - content

contentValues - the content values that will be set

additionalParameters - Additional parameters

lang - Language of the content

logger - The logger

Returns:

the ids of the contents that are not part of the synchronization

additionalImportOperations

public ContentSynchronizationResult additionalImportOperations(ModifiableContent content,
 Map<String,Object> additionalParameters,
 Logger logger)

Description copied from interface: SynchronizableContentsCollection

Add specific fields to the content.

Parameters:

content - Content to update

additionalParameters - Additional parameters

logger - The logger

Returns:

The synchronization result of the import additional operations

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

getChildrenAttributeName

protected String getChildrenAttributeName()

Description copied from class: AbstractApogeeSynchronizableContentsCollection

Get the attribute name to get children

Specified by:

getChildrenAttributeName in class AbstractApogeeSynchronizableContentsCollection

Returns:

the attribute name to get children

importCourseParts

protected List<ModifiableContent> importCourseParts(Content course,
 Logger logger)

Creates the course parts of the current Course.

Parameters:

course - The current Course

logger - The logger

Returns:

The list of the imported course parts

_addEditInputsForSCC

protected void _addEditInputsForSCC(Map<String,Object> inputs,
 WorkflowAwareContent content,
 Logger logger)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Add the inputs specific for the SCC to the inputs for edit content function.

Overrides:

_addEditInputsForSCC in class AbstractSimpleSynchronizableContentsCollection

Parameters:

inputs - The inputs to complete

content - The content to synchronize

logger - The logger