Package org.ametys.cms.clientsideelement

Class ScheduleArchivingClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.cms.clientsideelement.ScheduleArchivingClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class ScheduleArchivingClientSideElement
extends StaticClientSideElement

This element creates a ribbon button to schedule the archiving of a content

Nested Class Summary

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

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

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

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

Constructor Summary

Constructors

Constructor	Description
ScheduleArchivingClientSideElement()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getScheduledArchivingDate(List<String> contentIds)	Gets the scheduled archiving dates of one or several contents
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.
void	service(ServiceManager manager)
Map<String,Object>	setScheduledArchivingDate(List<String> contentIds, String scheduledDateAsStr)	Set or remove the ArchiveConstants.META_ARCHIVE_SCHEDULED_DATE on a content.

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

Constructor Detail

ScheduleArchivingClientSideElement

public ScheduleArchivingClientSideElement()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticFileImportsClientSideElement

Throws:

ServiceException

setScheduledArchivingDate

public Map<String,Object> setScheduledArchivingDate(List<String> contentIds,
                                                          String scheduledDateAsStr)

Set or remove the ArchiveConstants.META_ARCHIVE_SCHEDULED_DATE on a content.

Parameters:

contentIds - The ids of contents

scheduledDateAsStr - The schedule date as string

Returns:

the successful and failed contents

getScheduledArchivingDate

public Map<String,Object> getScheduledArchivingDate(List<String> contentIds)

Gets the scheduled archiving dates of one or several contents

Parameters:

contentIds - the ids of the contents

Returns:

result the server's response in JSON

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.