Package org.ametys.cms.clientsideelement

Class ScheduleContentPublicationClientSideElement

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.clientsideelement.ScheduleContentPublicationClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Contextualizable, Serviceable

public class ScheduleContentPublicationClientSideElement
extends SmartContentClientSideElement
implements Contextualizable

Client side element to schedule a workflow action on a selected content

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 Context	_context	The avalon context
protected Scheduler	_scheduler	The scheduler
static final String	PUBLISH_ACTION_ID	name of the publish scheduled action id in the content unversioned data holder
static final String	PUBLISH_DATE	name of the publish scheduled date data in the content unversioned data holder
static final String	UNPUBLISH_ACTION_ID	name of the unpublish scheduled action id in the content unversioned data holder
static final String	UNPUBLISH_DATE	name of the unpublish scheduled date data in the content unversioned data holder

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

Method Summary

Modifier and Type	Method	Description
protected ClientSideElement.Script	_configureScript(Configuration configuration)	Configure the script
protected int	_workflowAction(Content content)	Determines if the workflow action is correct
void	contextualize(Context context)
Map<String,Object>	getScheduleInfo(String contentId)	Get the schedule info of the content
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.
Map<String,Object>	scheduleAction(String contentId, String startDateAsStr, String endDateAsStr)	Schedule the execution of a workflow action at a given date
void	service(ServiceManager manager)

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

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

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

_configureClass, _configureParameters, configureInitialParameters

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

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, configure, getDependencies, getId, getPluginName, getRights, getScripts, 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

PUBLISH_DATE

public static final String PUBLISH_DATE

name of the publish scheduled date data in the content unversioned data holder

See Also:

• Constant Field Values

PUBLISH_ACTION_ID

public static final String PUBLISH_ACTION_ID

name of the publish scheduled action id in the content unversioned data holder

See Also:

• Constant Field Values

UNPUBLISH_DATE

public static final String UNPUBLISH_DATE

name of the unpublish scheduled date data in the content unversioned data holder

See Also:

• Constant Field Values

UNPUBLISH_ACTION_ID

public static final String UNPUBLISH_ACTION_ID

name of the unpublish scheduled action id in the content unversioned data holder

See Also:

• Constant Field Values

_context

protected Context _context

The avalon context

_scheduler

protected Scheduler _scheduler

The scheduler

Constructor Details

ScheduleContentPublicationClientSideElement

public ScheduleContentPublicationClientSideElement()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class SmartContentClientSideElement

Throws:

ServiceException

_configureScript

protected ClientSideElement.Script _configureScript(Configuration configuration)
                                             throws ConfigurationException

Description copied from class: StaticFileImportsClientSideElement

Configure the script

Overrides:

_configureScript in class StaticClientSideElement

Parameters:

configuration - the global configuration

Returns:

The script created

Throws:

ConfigurationException - The configuration is incorrect

getScheduleInfo

public Map<String,Object> getScheduleInfo(String contentId)

Get the schedule info of the content

Parameters:

contentId - the content identifier

Returns:

the scheduled date if any

scheduleAction

public Map<String,Object> scheduleAction(String contentId,
 String startDateAsStr,
 String endDateAsStr)

Schedule the execution of a workflow action at a given date

Parameters:

contentId - the identifier of the content to act on

startDateAsStr - the date of publication as an ISO date-time string

endDateAsStr - the date of unpublication as an ISO date-time string

Returns:

true if the action is a success

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

_workflowAction

protected int _workflowAction(Content content)

Description copied from class: SmartContentClientSideElement

Determines if the workflow action is correct

Overrides:

_workflowAction in class SmartContentClientSideElement

Parameters:

content - the content

Returns:

true if the workflow action is incorrect