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
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
Modifier and TypeFieldDescriptionprotected AmetysObjectResolver
The ametys resolverprotected WorkflowHelper
The workflow helperprotected WorkflowProvider
The workflow providerFields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement
_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected 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 actionsprotected void
_addActionsInfo
(Map<String, Object> result, com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor) Add actions info to the result mapprotected 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 stepsprotected void
_addStepsInfo
(Map<String, Object> result, com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor) Add steps info to the result mapprotected void
_addWorkflowInfo
(Map<String, Object> result, com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor) Add workflow info to the result mapgetScripts
(boolean ignoreRights, Map<String, Object> contextParameters) This method return the scripts that will be used on client side.getSubWorkflowNames
(String calendarId) Retrieves the child workflow names for a given calendargetSubWorkflowNames
(Calendar calendar) Retrieves the child workflow names for a given calendarGet info about each existing workflow.getWorkflowState
(String eventId, String workflowName, int workflowStepId, List<Integer> workflowActionsIds) Get the workflow state of an eventvoid
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
-
Field Details
-
_workflowProvider
The workflow provider -
_workflowHelper
The workflow helper -
_resolver
The ametys resolver
-
-
Constructor Details
-
CalendarsTabClientSideElement
public CalendarsTabClientSideElement()
-
-
Method Details
-
service
- Specified by:
service
in interfaceServiceable
- Overrides:
service
in classStaticFileImportsClientSideElement
- 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 interfaceClientSideElement
- Overrides:
getScripts
in classStaticFileImportsClientSideElement
- 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
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 populateworkflowDescriptor
- 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 populateworkflowDescriptor
- 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 populateworkflowDescriptor
- the workflow descriptorstep
- 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 populateworkflowDescriptor
- 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 populateworkflowDescriptor
- the workflow descriptoraction
- the action descriptor
-
getSubWorkflowNames
Retrieves the child workflow names for a given calendar- Parameters:
calendarId
- The calendar identifier- Returns:
- The child workflow names
-
getSubWorkflowNames
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 eventworkflowName
- The workflow nameworkflowStepId
- The workflow step idworkflowActionsIds
- The list of action ids- Returns:
- The workflow state
-