01: /*
02: * Created on Mar 18, 2003
03: */
04: package net.sf.jportlet.portlet.event;
05:
06: import net.sf.jportlet.portlet.PortletURI;
07:
08: /**
09: * An <code>ActionEvent</code> is sent by the portlet container when an HTTP
10: * request is received that is associated with an action
11: *
12: * @author <a href="mailto:tchbansi@sourceforge.net">Herve Tchepannou</a>
13: */
14: public interface ActionEvent extends Event {
15: //~ Static fields/initializers ---------------------------------------------
16:
17: /** Name of the action if the portlet in {@link net.sf.jportlet.portlet.Portlet.Mode#CONFIGURE} mode */
18: public static String ACTION_CONFIGURE = "configure";
19:
20: /** Name of the action if the portlet in {@link net.sf.jportlet.portlet.Portlet.Mode#EDIT} mode */
21: public static String ACTION_EDIT = "edit";
22:
23: /** Name of the action if the portlet in {@link net.sf.jportlet.portlet.Portlet.Mode#HELP} mode */
24: public static String ACTION_HELP = "help";
25:
26: /** Name of the action if the portlet in {@link net.sf.jportlet.portlet.Portlet.Mode#VIEW} mode */
27: public static String ACTION_VIEW = "view";
28:
29: /** Code to return if an error has occured while perfoming the action */
30: public static String RETURN_ERROR = "error";
31:
32: /** Code to return if performing the action was successfull */
33: public static String RETURN_SUCCESS = "success";
34:
35: /** Code to return if mode input data are required */
36: public static String RETURN_INPUT = "input";
37:
38: //~ Methods ----------------------------------------------------------------
39:
40: /**
41: * Add an error.
42: * @return Collection
43: */
44: public void addError(Object error);
45:
46: /**
47: * Return <code>true</code> if the action has errors
48: * @return boolean
49: */
50: public boolean hasErrors();
51:
52: /**
53: * Returns the action that this action event carries.
54: * The action value is either {@link #ACTION_VIEW} or {@link #ACTION_EDIT}
55: * or {@link #ACTION_CONFIGURE} or {@link #ACTION_HELP}
56: *
57: * @return PortletAction
58: */
59: public String getAction();
60:
61: /**
62: * Returns the returnCode.
63: * The <code>returnCode</code> is used by the container for managing the
64: * navigation using the <code><webflow></code> tag from the portlet
65: * deployment descriptor, if the <code>nextURI</code>
66: * was not set with {@link #setNextURI(net.sf.jportlet.portlet.PortletURI)}.
67: *
68: * @return String
69: */
70: public String getReturnCode();
71:
72: /**
73: * Return the URI where to move after the action is executed. If not set,
74: * the container will used {@link #getReturnCode()} to determine the URI where to move.
75: * This is useful for managing navigation inside the portlet.
76: *
77: * @return PortletURI
78: */
79: public PortletURI getNextURI();
80:
81: /**
82: * Set the returnCode.
83: *
84: * @param returnCode
85: * @see #RETURN_SUCCESS
86: * @see #RETURN_ERROR
87: * @see #RETURN_INPUT
88: */
89: public void setReturnCode(String returnCode);
90:
91: /**
92: * Set the URI where to move after the action is executed
93: *
94: * @param uri next URI
95: */
96: public void setNextURI(PortletURI nextURI);
97: }
|