001: /*
002: * @author <a href="mailto:novotny@gridsphere.org">Jason Novotny</a>
003: * @version $Id: FormEvent.java 6385 2007-10-25 14:02:26Z wehrens $
004: */
005: package org.gridsphere.provider.event.jsr;
006:
007: import org.gridsphere.provider.portletui.beans.*;
008: import org.gridsphere.services.core.persistence.QueryFilter;
009:
010: import java.io.IOException;
011: import java.util.Map;
012:
013: /**
014: * The <code>FormEvent</code> provides a decorator around a <code>ActionEvent</code> and is used in the GridSphere
015: * <code>ActionPortlet</code> model to create and store visual beans representing user interfaces.
016: */
017: public interface FormEvent {
018:
019: /**
020: * Return an existing <code>ActionLinkBean</code> or create a new one
021: *
022: * @param beanId the bean identifier
023: * @return a ActionLinkBean
024: */
025: public ActionLinkBean getActionLinkBean(String beanId);
026:
027: /**
028: * Return an existing <code>ParamBean</code> or create a new one
029: *
030: * @param beanId the bean identifier
031: * @return a ParamBean
032: */
033: public ParamBean getParamBean(String beanId);
034:
035: /**
036: * Return an existing <code>ActionSubmitBean</code> or create a new one
037: *
038: * @param beanId the bean identifier
039: * @return a ActionSubmitBean
040: */
041: public ActionSubmitBean getActionSubmitBean(String beanId);
042:
043: /**
044: * Return an existing <code>FrameBean</code> or create a new one
045: *
046: * @param beanId the bean identifier
047: * @return a FrameBean
048: */
049: public FrameBean getFrameBean(String beanId);
050:
051: /**
052: * Return an existing <code>FileInputBean</code> or create a new one
053: *
054: * @param beanId the bean identifier
055: * @return a FileInputBean
056: * @throws IOException if an I/O error occurs
057: */
058: public FileInputBean getFileInputBean(String beanId)
059: throws IOException;
060:
061: /**
062: * Return an existing <code>CalendarBean</code> or create a new one
063: *
064: * @param beanId the bean identifier
065: * @return a CalendarBean
066: */
067: public CalendarBean getCalendarBean(String beanId);
068:
069: /**
070: * Return an existing <code>CheckBoxBean</code> or create a new one
071: *
072: * @param beanId the bean identifier
073: * @return a CheckBoxBean
074: */
075: public CheckBoxBean getCheckBoxBean(String beanId);
076:
077: /**
078: * Return an existing <code>RadioButtonBean</code> or create a new one
079: *
080: * @param beanId the bean identifier
081: * @return a RadioButtonBean
082: */
083: public RadioButtonBean getRadioButtonBean(String beanId);
084:
085: /**
086: * Return an existing <code>TextFieldBean</code> or create a new one
087: *
088: * @param beanId the bean identifier
089: * @return a TextFieldBean
090: */
091: public TextFieldBean getTextFieldBean(String beanId);
092:
093: /**
094: * Return an existing <code>TextEditorBean</code> or create a new one
095: *
096: * @param beanId the bean identifier
097: * @return a TextEditorBean
098: */
099: public TextEditorBean getTextEditorBean(String beanId);
100:
101: /**
102: * Return an existing <code>RichTextEditroBean</code> or cerate a new one.
103: *
104: * @param beanId the bean identifier
105: * @return a RichTextEditorBean
106: */
107: public RichTextEditorBean getRichTextEditorBean(String beanId);
108:
109: /**
110: * Return an existing <code>TreeBean</code> or create a new one.
111: *
112: * @param beanId bendId of the bean Idetifier
113: * @return a TreeBean
114: */
115: public TreeBean getTreeBean(String beanId);
116:
117: /**
118: * Return an existing <code>HiddenFieldBean</code> or create a new one
119: *
120: * @param beanId the bean identifier
121: * @return a HiddenFieldBean
122: */
123: public HiddenFieldBean getHiddenFieldBean(String beanId);
124:
125: /**
126: * Return an existing <code>PasswordBean</code> or create a new one
127: *
128: * @param beanId the bean identifier
129: * @return a PasswordBean
130: */
131: public PasswordBean getPasswordBean(String beanId);
132:
133: /**
134: * Return an existing <code>TextAreaBean</code> or create a new one
135: *
136: * @param beanId the bean identifier
137: * @return a TextAreaBean
138: */
139: public TextAreaBean getTextAreaBean(String beanId);
140:
141: /**
142: * Return an existing <code>TextBean</code> or create a new one
143: *
144: * @param beanId the bean identifier
145: * @return a TextBean
146: */
147: public TextBean getTextBean(String beanId);
148:
149: /**
150: * Return an existing <code>ImageBean</code> or create a new one
151: *
152: * @param beanId the bean identifier
153: * @return a ImageBean
154: */
155: public ImageBean getImageBean(String beanId);
156:
157: /**
158: * Return an existing <code>ListBoxBean</code> or create a new one
159: *
160: * @param beanId the bean identifier
161: * @return a ListBoxBean
162: */
163: public ListBoxBean getListBoxBean(String beanId);
164:
165: /**
166: * Return an existing <code>PanelBean</code> or create a new one
167: *
168: * @param beanId the bean identifier
169: * @return a PanelBean
170: */
171: public PanelBean getPanelBean(String beanId);
172:
173: /**
174: * Return an existing <code>TableCellBean</code> or create a new one
175: *
176: * @param beanId the bean identifier
177: * @return a TableCellBean
178: */
179: public TableCellBean getTableCellBean(String beanId);
180:
181: /**
182: * Return an existing <code>TableRowBean</code> or create a new one
183: *
184: * @param beanId the bean identifier
185: * @return a TableRowBean
186: */
187: public TableRowBean getTableRowBean(String beanId);
188:
189: /**
190: * Return an existing <code>TableBean</code> or create a new one
191: *
192: * @param beanId the bean identifier
193: * @return a TableBean
194: */
195: public TableBean getTableBean(String beanId);
196:
197: /**
198: * Returns the collection of visual tag beans contained by this form event
199: *
200: * @return the collection of visual tag beans
201: */
202: public Map getTagBeans();
203:
204: public ActionMenuBean getActionMenuBean(String beanId);
205:
206: public ActionMenuItemBean getActionMenuItemBean(String beanId);
207:
208: /**
209: * Return an existing <code>IncludeBean</code> or create a new one
210: *
211: * @param beanId the bean identifier
212: * @return an include bean
213: */
214: public IncludeBean getIncludeBean(String beanId);
215:
216: /**
217: * Return an existing <code>MessageBoxBean</code> or create a new one
218: *
219: * @param beanId bean identifier
220: * @return a mesage box bean
221: */
222: public MessageBoxBean getMessageBoxBean(String beanId);
223:
224: public QueryFilter getQueryFilter(int maxResults, int totalItems);
225:
226: /**
227: * Stores any created beans into the request
228: */
229: public void store();
230:
231: }
|