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

Class ContainerNbStudentsSynchronizableContentsCollection

java.lang.Object

org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSimpleSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.impl.AbstractDefaultSynchronizableContentsCollection

org.ametys.plugins.odfsync.apogee.scc.AbstractPreviousYearsSynchronizableContentsCollection

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

All Implemented Interfaces:

SynchronizableContentsCollection, Configurable, Serviceable

public class ContainerNbStudentsSynchronizableContentsCollection
extends AbstractPreviousYearsSynchronizableContentsCollection

SCC for nbStudents fields for container contents.

Field Summary

Fields

Modifier and Type	Field	Description
protected OdfReferenceTableHelper	_odfRefTableHelper	The ODF reference table helper

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

_apogeePreviousYearsFieldsDAO, _apogeeSCCHelper, _cdmfrHandler, PARAM_CURRENT_YEAR, PARAM_DATASOURCE_ID, PARAM_PRECEDING_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

_checkCollection, _compatibleSCC, _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, LAST_SYNCHRONIZATION_DATA_NAME, LAST_SYNCHRONIZATION_USER_DATA_NAME, RESULT_NB_CREATED_CONTENTS, RESULT_NB_DELETED_CONTENTS, RESULT_NB_NOT_CHANGED_CONTENTS, RESULT_NB_SYNCHRONIZED_CONTENTS

Constructor Summary

Constructors

Constructor	Description
ContainerNbStudentsSynchronizableContentsCollection()

Method Summary

Modifier and Type	Method	Description
protected List<Map<String,Object>>	executeApogeeRequest(Map<String,Object> parameters)	Execute the corresponding apogee request to retrieve the values from Apogee
protected Stream<Content>	getContents()	Retrieve the contents for which to retrieve the values
protected String	getCurrentYearAttributeName()	Get the attribute name for current year data.
String	getIdField()	Get the path of metadata holding the unique identifier
protected String	getPrecedingYearAttributeName()	Get the attribute name for preceding year data.
protected String	getSyncCodeItemName()	Get the item name that contains the synchronization code, it can be an attribute or a property.
void	service(ServiceManager manager)

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

_endHandleCDMFR, _getExpressionsList, _importContent, _startHandleCDMFR, checkCollection, ensureTitleIsPresent, getCurrentYear, getDataSourceId, getIdColumn, getLanguages, getLocalAndExternalFields, getPrecedingYear, getSyncCode, internalSearch, populate, searchByYear, updateSyncInformations

Methods inherited from class org.ametys.plugins.contentio.synchronize.impl.AbstractDefaultSynchronizableContentsCollection

_getMapping, configureDataSource, configureSearchModel, getRemoteValues, putIdParameter, search

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

_addEditInputsForSCC, _editContent, _fillContent, _getContentsToRemove, _getEditInputs, _getEditInputsContextParameters, _handleContent, _importOrSynchronizeContent, _importOrSynchronizeContent, _importOrSynchronizeContents, _importOrSynchronizeContents, _internalPopulate, _isHandled, _synchronizeContent, _transformRemoteValues, configure, createContentAction, getAdditionalAttributeValues, getContent, getNotSynchronizedRelatedContentIds, getTotalCount, getTransformedRemoteValues, importContent, synchronizeContent, validateContent

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

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

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

_parseMultipleValuesConf, _parseParameters, _transformRemoteValuesCardinality, configureStaticParams, getCompatibleSCC, 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, additionalImportOperations, additionalSynchronizeOperations, handleRightAssignmentContext

Field Details

_odfRefTableHelper

protected OdfReferenceTableHelper _odfRefTableHelper

The ODF reference table helper

Constructor Details

ContainerNbStudentsSynchronizableContentsCollection

public ContainerNbStudentsSynchronizableContentsCollection()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractPreviousYearsSynchronizableContentsCollection

Throws:

ServiceException

getIdField

public String getIdField()

Description copied from interface: SynchronizableContentsCollection

Get the path of metadata holding the unique identifier

Returns:

the path to the metadata. Can be null.

getCurrentYearAttributeName

protected String getCurrentYearAttributeName()

Description copied from class: AbstractPreviousYearsSynchronizableContentsCollection

Get the attribute name for current year data.

Specified by:

getCurrentYearAttributeName in class AbstractPreviousYearsSynchronizableContentsCollection

Returns:

the attribute name

getPrecedingYearAttributeName

protected String getPrecedingYearAttributeName()

Description copied from class: AbstractPreviousYearsSynchronizableContentsCollection

Get the attribute name for preceding year data.

Specified by:

getPrecedingYearAttributeName in class AbstractPreviousYearsSynchronizableContentsCollection

Returns:

the attribute name

getContents

protected Stream<Content> getContents()

Description copied from class: AbstractPreviousYearsSynchronizableContentsCollection

Retrieve the contents for which to retrieve the values

Overrides:

getContents in class AbstractPreviousYearsSynchronizableContentsCollection

Returns:

The contents

getSyncCodeItemName

protected String getSyncCodeItemName()

Description copied from class: AbstractPreviousYearsSynchronizableContentsCollection

Get the item name that contains the synchronization code, it can be an attribute or a property.

Specified by:

getSyncCodeItemName in class AbstractPreviousYearsSynchronizableContentsCollection

Returns:

the synchronization code item name

executeApogeeRequest

protected List<Map<String,Object>> executeApogeeRequest(Map<String,Object> parameters)

Description copied from class: AbstractPreviousYearsSynchronizableContentsCollection

Execute the corresponding apogee request to retrieve the values from Apogee

Specified by:

executeApogeeRequest in class AbstractPreviousYearsSynchronizableContentsCollection

Parameters:

parameters - The parameters of the request

Returns:

The results of the request