Package org.ametys.cms.alerts

Class ContentAlertsClientSideElement

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.cms.alerts.ContentAlertsClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class ContentAlertsClientSideElement
extends SmartContentClientSideElement

This element creates a toggle button representing the reminders state.

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 Scheduler	_scheduler	The ametys scheduler

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
ContentAlertsClientSideElement()

Method Summary

Modifier and Type	Method	Description
protected void	_setAlerts(ModifiableDataAwareVersionableAmetysObject content, Map<String,Object> params)	Sets the alerts on the specified content.
Map<String,Object>	getAlertsInformations(List<String> contentsId)	Get information on reminders state.
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.
Map<String,Object>	getStatus(List<String> contentsId)	Get informations on contents' state This method should only be used if you need additional information than the default one.
void	service(ServiceManager serviceManager)
Map<String,Object>	setAlertsOnContent(List<String> contentIds, Map<String,Object> params)	Set alerts on content

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

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

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

_scheduler

protected Scheduler _scheduler

The ametys scheduler

Constructor Details

ContentAlertsClientSideElement

public ContentAlertsClientSideElement()

Method Details

service

public void service(ServiceManager serviceManager)
             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.

getStatus

public Map<String,Object> getStatus(List<String> contentsId)

Description copied from class: SmartContentClientSideElement

Get informations on contents' state This method should only be used if you need additional information than the default one. Otherwise use the JS implementation provided by SmartContentController._calculateStatus When called inside a Callable, you can consider that this method will do the right check as long as you only do additional processing on the "allright-contents".

Overrides:

getStatus in class SmartContentClientSideElement

Parameters:

contentsId - the ids of contents

Returns:

informations on contents' state

getAlertsInformations

public Map<String,Object> getAlertsInformations(List<String> contentsId)

Get information on reminders state.

Parameters:

contentsId - The list of contents' ids

Returns:

informations on reminders state.

setAlertsOnContent

public Map<String,Object> setAlertsOnContent(List<String> contentIds,
 Map<String,Object> params)

Set alerts on content

Parameters:

contentIds - the content's id

params - the alerts' parameters

Returns:

The result

_setAlerts

protected void _setAlerts(ModifiableDataAwareVersionableAmetysObject content,
 Map<String,Object> params)
                   throws AmetysRepositoryException

Sets the alerts on the specified content.

Parameters:

content - the content to set the alerts on.

params - the alerts' parameters

Throws:

AmetysRepositoryException - if a repository error occurs.