public interface PluggableActionContext
Modifier and Type | Method and Description |
---|---|
void |
addActionResponse(String actionId,
PluggableActionResponse actionResponse)
add the pluggable action response of an already (successfully) invoked
action to the context
|
void |
addAdditionalActionData(String key,
Object object)
add an additional piece of information that can be resolved using the
resolver returned by
getAdditionalDataResolver() . |
void |
clearView()
Clear the view of this context
|
boolean |
clearView(String viewId)
Clear the view with the given id
|
void |
fillFormFromResolvable(Resolvable object)
Fill the attributes of the resolvable into the view of this context
|
boolean |
fillFormFromResolvable(String viewId,
Resolvable object)
Fill the attribute of the resolvable object into the view with the given id
|
void |
fillMapFromForm(Map componentData)
Fill the attributes from the view of this context into the map
|
boolean |
fillMapFromForm(String viewId,
Map componentData)
Fill the attributes from the view with the given id into the map
|
void |
fillObjectFromForm(Resolvable object,
List writtenAttributes)
Fill the attributes from the view of this context into the resolvable object
|
boolean |
fillObjectFromForm(String viewId,
Resolvable object,
List writtenAttributes)
Fill the attributes from the view with the given id into the resolvable object
|
Resolvable |
getActionResolver()
get a resolvable to resolve actions (and their response parameters)
|
Resolvable |
getAdditionalDataResolver()
get the resolver for the data added with
addAdditionalActionData(String, Object) . |
Map |
getBaseObjects()
Get an unmodifiable map of the context base objects
|
PropertySetter |
getContextPropertySetter()
Get the property setter for all context properties.
|
GenticsPortlet |
getModule()
get the module that uses the pluggable action
|
javax.portlet.PortletRequest |
getPortletRequest()
get the originating portlet request
|
RuleTree |
getRuleTree()
get a ruletree that can resolve everything in the context of the actions
|
TemplateProcessor |
getTemplateProcessor()
Get a template processor.
|
boolean |
hideView(String viewId)
Hide the given view (only works for nested forms)
|
void |
returnTemplateProcessor(TemplateProcessor templateProcessor)
Return the template processor which was previously fetched via
getTemplateProcessor() . |
boolean |
switchToView(String viewId)
Switch to the view with the given id
|
void |
triggerEvent(ActionEvent event)
trigger an action event
|
GenticsPortlet getModule()
void triggerEvent(ActionEvent event) throws NoEventsAllowedException
event
- action event to triggerNoEventsAllowedException
- when events cannot be handled right nowvoid addActionResponse(String actionId, PluggableActionResponse actionResponse)
actionId
- id of the actionactionResponse
- pluggable action responseResolvable getActionResolver()
void addAdditionalActionData(String key, Object object)
getAdditionalDataResolver()
.key
- key of the propertyobject
- data to be resolvedResolvable getAdditionalDataResolver()
addAdditionalActionData(String, Object)
.RuleTree getRuleTree()
javax.portlet.PortletRequest getPortletRequest()
PropertySetter getContextPropertySetter()
Map getBaseObjects()
void fillObjectFromForm(Resolvable object, List writtenAttributes)
object
- resolvable object to fill with attributeswrittenAttributes
- list to collect the really written attributesboolean fillObjectFromForm(String viewId, Resolvable object, List writtenAttributes)
viewId
- id of the viewobject
- resolvable object to fill with attributeswrittenAttributes
- list to collect the really written attributesvoid fillMapFromForm(Map componentData)
componentData
- map that is filled with the component databoolean fillMapFromForm(String viewId, Map componentData)
viewId
- id of the viewcomponentData
- map that is filled with the component datavoid fillFormFromResolvable(Resolvable object)
object
- boolean fillFormFromResolvable(String viewId, Resolvable object)
viewId
- view idobject
- resolvable objectboolean switchToView(String viewId)
viewId
- id of the viewboolean hideView(String viewId)
viewId
- id of the view, must inlude the id of the nestedform to hide ([viewid].[nestedformid])boolean clearView(String viewId)
viewId
- id of the viewvoid clearView()
TemplateProcessor getTemplateProcessor()
returnTemplateProcessor(TemplateProcessor)
after usagevoid returnTemplateProcessor(TemplateProcessor templateProcessor)
getTemplateProcessor()
.templateProcessor
- template processor that is no longer usedCopyright © 2015 Gentics Software GmbH. All Rights Reserved.