Package org.ametys.plugins.explorer.calendars.clientside

Class CalendarsTabClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.plugins.explorer.calendars.clientside.CalendarsTabClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class CalendarsTabClientSideElement
extends StaticClientSideElement

Ribbon tab client side element for calendars

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 AmetysObjectResolver	_resolver	The ametys resolver
protected WorkflowHelper	_workflowHelper	The workflow helper
protected WorkflowProvider	_workflowProvider	The workflow provider

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

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

Constructor Summary

Constructors

Constructor	Description
CalendarsTabClientSideElement()

Method Summary

Modifier and Type	Method	Description
protected void	_addActionInfo(Map<String,Object> actionMap, com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor, com.opensymphony.workflow.loader.ActionDescriptor action)	Add action info to the map of actions
protected void	_addActionsInfo(Map<String,Object> result, com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor)	Add actions info to the result map
protected void	_addStepInfo(Map<String,Object> stepMap, com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor, com.opensymphony.workflow.loader.StepDescriptor step)	Add step info to the map of steps
protected void	_addStepsInfo(Map<String,Object> result, com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor)	Add steps info to the result map
protected void	_addWorkflowInfo(Map<String,Object> result, com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor)	Add workflow info to the result map
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.
Set<String>	getSubWorkflowNames(String calendarId)	Retrieves the child workflow names for a given calendar
Set<String>	getSubWorkflowNames(Calendar calendar)	Retrieves the child workflow names for a given calendar
Map<String,Object>	getWorkflowsInfo()	Get info about each existing workflow.
Map<String,Object>	getWorkflowState(String eventId, String workflowName, int workflowStepId, List<Integer> workflowActionsIds)	Get the workflow state of an event
void	service(ServiceManager serviceManager)

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 Detail

_workflowProvider

protected WorkflowProvider _workflowProvider

The workflow provider

_workflowHelper

protected WorkflowHelper _workflowHelper

The workflow helper

_resolver

protected AmetysObjectResolver _resolver

The ametys resolver

Constructor Detail

CalendarsTabClientSideElement

public CalendarsTabClientSideElement()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticFileImportsClientSideElement

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.

getWorkflowsInfo

public Map<String,Object> getWorkflowsInfo()

Get info about each existing workflow.

Returns:

a list of map containing workflow info. For each entry, the key is the workflow name and the value is a map containing the necessary workflow data

_addWorkflowInfo

protected void _addWorkflowInfo(Map<String,Object> result,
                                com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor)

Add workflow info to the result map

Parameters:

result - The result map to populate

workflowDescriptor - the workflow descriptor

_addStepsInfo

protected void _addStepsInfo(Map<String,Object> result,
                             com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor)

Add steps info to the result map

Parameters:

result - The result map to populate

workflowDescriptor - the workflow descriptor

_addStepInfo

protected void _addStepInfo(Map<String,Object> stepMap,
                            com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor,
                            com.opensymphony.workflow.loader.StepDescriptor step)

Add step info to the map of steps

Parameters:

stepMap - The step map to populate

workflowDescriptor - the workflow descriptor

step - the step descriptor

_addActionsInfo

protected void _addActionsInfo(Map<String,Object> result,
                               com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor)

Add actions info to the result map

Parameters:

result - The result map to populate

workflowDescriptor - the workflow descriptor

_addActionInfo

protected void _addActionInfo(Map<String,Object> actionMap,
                              com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor,
                              com.opensymphony.workflow.loader.ActionDescriptor action)

Add action info to the map of actions

Parameters:

actionMap - The action map to populate

workflowDescriptor - the workflow descriptor

action - the action descriptor

getSubWorkflowNames

public Set<String> getSubWorkflowNames(String calendarId)

Retrieves the child workflow names for a given calendar

Parameters:

calendarId - The calendar identifier

Returns:

The child workflow names

getSubWorkflowNames

public Set<String> getSubWorkflowNames(Calendar calendar)

Retrieves the child workflow names for a given calendar

Parameters:

calendar - The calendar

Returns:

The child workflow names

getWorkflowState

public Map<String,Object> getWorkflowState(String eventId,
                                                 String workflowName,
                                                 int workflowStepId,
                                                 List<Integer> workflowActionsIds)

Get the workflow state of an event

Parameters:

eventId - The id of the event

workflowName - The workflow name

workflowStepId - The workflow step id

workflowActionsIds - The list of action ids

Returns:

The workflow state