Package com.gentics.api.portalnode.event
Interface ActionEvent
-
public interface ActionEvent
Interface for an action event that may be triggered and handled inside the portal.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getActionCommand()
Get the action command of the eventActionEvent
getEmbeddedEvent()
Get the embedded eventString
getObjectPath()
Object
getParameter(String name)
Get the action parameter with given nameObject
getParameter(String name, Object defaultValue)
Get the action parameter with given name or the default value if the parameter is not setMap
getParameterMap()
Get a map of all event parametersvoid
setEmbeddedEvent(ActionEvent evt)
Set the embedded eventvoid
setObjectPath(String path)
void
setParameter(String name, Object value)
Set the parameter with given name
-
-
-
Method Detail
-
getActionCommand
String getActionCommand()
Get the action command of the event- Returns:
- action command string
-
getObjectPath
String getObjectPath()
-
setObjectPath
void setObjectPath(String path)
-
getParameter
Object getParameter(String name)
Get the action parameter with given name- Parameters:
name
- name of the action parameter- Returns:
- the value of the parameter or null if the parameter is not set
-
getParameter
Object getParameter(String name, Object defaultValue)
Get the action parameter with given name or the default value if the parameter is not set- Parameters:
name
- name of the action parameterdefaultValue
- default value to be returned when the parameter is not set- Returns:
- the value of the parameter or the default value when the parameter is not set
-
getParameterMap
Map getParameterMap()
Get a map of all event parameters- Returns:
- Map where the keys are the parameter names and values are the parameter values
-
getEmbeddedEvent
ActionEvent getEmbeddedEvent()
Get the embedded event- Returns:
- the embedded event or null
-
setEmbeddedEvent
void setEmbeddedEvent(ActionEvent evt)
Set the embedded event- Parameters:
evt
- an event this event shall wrap
-
-