[WIKI-UPDATE] XSPAction Sun May 18 11:00:02 2003

[st...@outerthought.org]

Page: http://wiki.cocoondev.org/Wiki.jsp?page=XSPAction , version: 13 on Sun May 18 08:42:38 2003 by AntonioGallardo

+ !! Description
+ 
+ To write an XSP Action you need to declarate the use of the built-in logicsheet ''action''. In the header of your XSP please include:
+ 
+ {{{
+ xmlns:action="http://apache.org/cocoon/action/1.0"
+ }}}
+ 
+ !! Allowed Tags
+ 
+ Here is a description of all the tags and the parameters it uses:
+ 
+ * __<action:redirect-to>__ - Redirects to a given URL.
+ ** __{{uri}}__ - The URI to redirect-to (String)
+ ** __{{session-mode}}__ - Keep session across redirect (boolean, default = true)
+ 
+ ***{{''Example:'' <action:redirect-to uri="ToURI" session-mode="false"/>}}
+ 
+ *__<action:set-result>__ - Adds an entry in the action result map. Implicitly set the action status to successful
+ **{{__name__}} - The entry name (String)
+ **{{__value__}} - The entry value (String)
+ 
+ ***{{''Example:'' <action:set-result name="MyName" value="MyValue"/>}}
+ 
+ *__<action:get-result>__ - Gets the value of an entry of the Action result map (previously set
+    with {{<action:set-result>}})
+ **__{{name}}__ - The entry name (String)
+ 
+ ***{{''Example:'' <action:get-result name="MyName"/>}}
+ 
+ *__<action:set-success>__ - Sets the action status to successful
+ **Does not have any parameter
+ 
+ ***{{''Example:'' <action:set-success/>}}
+ 
+ *__<action:set-failure>__ - Sets the action status to failure ''(child statements in the sitemap won't be
+    executed)''.
+ 
+ ***{{''Example:'' <action:set-failure/>}}
+ ----