Package org.ametys.plugins.contentio.synchronize.clientsideelement

Class SCCSmartContentClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.cms.clientsideelement.SmartContentClientSideElement

org.ametys.plugins.contentio.synchronize.clientsideelement.SCCSmartContentClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

PegaseSCCSmartContentClientSideElement

public class SCCSmartContentClientSideElement
extends SmartContentClientSideElement

Smart content client side element for SCC, the SCC model ID configured in plugin.xml is used.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields

Modifier and Type	Field	Description
protected SynchronizableContentsCollectionHelper	_sccHelper	SCC helper

Fields inherited from class org.ametys.cms.clientsideelement.SmartContentClientSideElement

_contentHelper, _resolver, _smartHelper

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor	Description
SCCSmartContentClientSideElement()

Method Summary

Modifier and Type	Method	Description
protected ClientSideElement.Script	_getScriptFromCollection(ClientSideElement.Script script, SynchronizableContentsCollection collection)	Get a cloned script by updating configuration with collection values.
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.
String	getSyncCode(String contentId, String collectionId)	Get the value of the synchronization field.
void	service(ServiceManager smanager)
boolean	synchronizeContent(String collectionId, String contentId, String syncCode)	Synchronize the content on the given collection with the given synchronization code.

Methods inherited from class org.ametys.cms.clientsideelement.SmartContentClientSideElement

_getAllRightDescription, _getIncorrectWorkflowStepDescription, _getLockedDescription, _getNoModifiableDescription, _getNoRightDescription, _getWorkflowActionUnvailableDescription, _hasReadAccess, _hasRight, _isAllRight, _isLocked, _isModifiable, _isWorkflowStepCorrect, _workflowAction, getContentDefaultParameters, getStatus

Methods inherited from class org.ametys.core.ui.StaticClientSideElement

_configureClass, _configureParameters, _configureScript, configureInitialParameters

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, configure, getDependencies, getId, getPluginName, getRights, getScripts, hasRight, setPluginInfo, toString

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

_sccHelper

protected SynchronizableContentsCollectionHelper _sccHelper

SCC helper

Constructor Details

SCCSmartContentClientSideElement

public SCCSmartContentClientSideElement()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class SmartContentClientSideElement

Throws:

ServiceException

getScripts

public List<ClientSideElement.Script> getScripts(boolean ignoreRights,
 Map<String,Object> contextParameters)

Description copied from interface: ClientSideElement

This method return the scripts that will be used on client side. This class will be parametrized by initial and current parameters.

Specified by:

getScripts in interface ClientSideElement

Overrides:

getScripts in class StaticFileImportsClientSideElement

Parameters:

ignoreRights - True to ignore the rights verification.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The list of scripts or an empty list.

_getScriptFromCollection

protected ClientSideElement.Script _getScriptFromCollection(ClientSideElement.Script script,
 SynchronizableContentsCollection collection)

Get a cloned script by updating configuration with collection values.

Parameters:

script - The script to clone

collection - The collection

Returns:

A cloned script

synchronizeContent

public boolean synchronizeContent(String collectionId,
 String contentId,
 String syncCode)

Synchronize the content on the given collection with the given synchronization code.

Parameters:

collectionId - Collection ID

contentId - Content ID

syncCode - Synchronization code

Returns:

true if an error occurred

getSyncCode

public String getSyncCode(String contentId,
 String collectionId)

Get the value of the synchronization field.

Parameters:

contentId - Content ID

collectionId - Collection ID

Returns:

The value of the synchronization field