|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PluggableActionContext
interface for the context of a pluggable action.
Method Summary | |
---|---|
void |
addActionResponse(java.lang.String actionId,
PluggableActionResponse actionResponse)
add the pluggable action response of an already (successfully) invoked action to the context |
void |
addAdditionalActionData(java.lang.String key,
java.lang.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(java.lang.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(java.lang.String viewId,
Resolvable object)
Fill the attribute of the resolvable object into the view with the given id |
void |
fillMapFromForm(java.util.Map componentData)
Fill the attributes from the view of this context into the map |
boolean |
fillMapFromForm(java.lang.String viewId,
java.util.Map componentData)
Fill the attributes from the view with the given id into the map |
void |
fillObjectFromForm(Resolvable object,
java.util.List writtenAttributes)
Fill the attributes from the view of this context into the resolvable object |
boolean |
fillObjectFromForm(java.lang.String viewId,
Resolvable object,
java.util.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) . |
java.util.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(java.lang.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(java.lang.String viewId)
Switch to the view with the given id |
void |
triggerEvent(ActionEvent event)
trigger an action event |
Method Detail |
---|
GenticsPortlet getModule()
void triggerEvent(ActionEvent event) throws NoEventsAllowedException
event
- action event to trigger
NoEventsAllowedException
- when events cannot be handled right nowvoid addActionResponse(java.lang.String actionId, PluggableActionResponse actionResponse)
actionId
- id of the actionactionResponse
- pluggable action responseResolvable getActionResolver()
void addAdditionalActionData(java.lang.String key, java.lang.Object object)
getAdditionalDataResolver()
.
key
- key of the propertyobject
- data to be resolvedResolvable getAdditionalDataResolver()
addAdditionalActionData(String, Object)
.
RuleTree getRuleTree()
javax.portlet.PortletRequest getPortletRequest()
PropertySetter getContextPropertySetter()
java.util.Map getBaseObjects()
void fillObjectFromForm(Resolvable object, java.util.List writtenAttributes)
object
- resolvable object to fill with attributeswrittenAttributes
- list to collect the really written attributesboolean fillObjectFromForm(java.lang.String viewId, Resolvable object, java.util.List writtenAttributes)
viewId
- id of the viewobject
- resolvable object to fill with attributeswrittenAttributes
- list to collect the really written attributes
void fillMapFromForm(java.util.Map componentData)
componentData
- map that is filled with the component databoolean fillMapFromForm(java.lang.String viewId, java.util.Map componentData)
viewId
- id of the viewcomponentData
- map that is filled with the component data
void fillFormFromResolvable(Resolvable object)
object
- boolean fillFormFromResolvable(java.lang.String viewId, Resolvable object)
viewId
- view idobject
- resolvable object
boolean switchToView(java.lang.String viewId)
viewId
- id of the view
boolean hideView(java.lang.String viewId)
viewId
- id of the view, must inlude the id of the nestedform to hide ([viewid].[nestedformid])
boolean clearView(java.lang.String viewId)
viewId
- id of the view
void clearView()
TemplateProcessor getTemplateProcessor()
returnTemplateProcessor(TemplateProcessor)
after usage
void returnTemplateProcessor(TemplateProcessor templateProcessor)
getTemplateProcessor()
.
templateProcessor
- template processor that is no longer used
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |