001: /*
002: * ====================================================================
003: * JAFFA - Java Application Framework For All
004: *
005: * Copyright (C) 2002 JAFFA Development Group
006: *
007: * This library is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU Lesser General Public
009: * License as published by the Free Software Foundation; either
010: * version 2.1 of the License, or (at your option) any later version.
011: *
012: * This library is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this library; if not, write to the Free Software
019: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020: *
021: * Redistribution and use of this software and associated documentation ("Software"),
022: * with or without modification, are permitted provided that the following conditions are met:
023: * 1. Redistributions of source code must retain copyright statements and notices.
024: * Redistributions must also contain a copy of this document.
025: * 2. Redistributions in binary form must reproduce the above copyright notice,
026: * this list of conditions and the following disclaimer in the documentation
027: * and/or other materials provided with the distribution.
028: * 3. The name "JAFFA" must not be used to endorse or promote products derived from
029: * this Software without prior written permission. For written permission,
030: * please contact mail to: jaffagroup@yahoo.com.
031: * 4. Products derived from this Software may not be called "JAFFA" nor may "JAFFA"
032: * appear in their names without prior written permission.
033: * 5. Due credit should be given to the JAFFA Project (http://jaffa.sourceforge.net).
034: *
035: * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
036: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
037: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
038: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
039: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
040: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
041: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
042: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
043: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
044: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
045: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
046: * SUCH DAMAGE.
047: * ====================================================================
048: */
049:
050: package org.jaffa.presentation.portlet.component;
051:
052: import org.jaffa.presentation.portlet.FormKey;
053: import org.jaffa.presentation.portlet.session.UserSession;
054: import org.jaffa.exceptions.ApplicationExceptions;
055: import org.jaffa.exceptions.FrameworkException;
056: import org.jaffa.presentation.portlet.FormKeyChangeEvent;
057: import org.jaffa.presentation.portlet.FormKeyChangeListener;
058:
059: /** All the components implement this interface
060: */
061: public interface IComponent {
062:
063: /** Returns a FormKey, which has the componentId & the formName to which control should be passed
064: * @throws FrameworkException if any framework error occurs.
065: * @throws ApplicationExceptions if any application error occurs.
066: * @return the FormKey object
067: */
068: public FormKey display() throws FrameworkException,
069: ApplicationExceptions;
070:
071: /** This will kill all the Forms
072: * Finally de-register itself from the UserSession
073: */
074: public void quit();
075:
076: /** This should invoke the quit() method, and then return the FormKey for the calling screen.
077: * The FormKey should have been set by a call to setReturnToFormKey().
078: * @return The FormKey for the caling screen. A null will be returned, if no calling screen was specified.
079: */
080: public FormKey quitAndReturnToCallingScreen();
081:
082: /** Returns the Id for the component
083: * @return The componentId
084: */
085: public String getComponentId();
086:
087: /** Returns the ComponentDefinition based on which this Component was created
088: * @return The ComponentDefintion object for the Component
089: */
090: public ComponentDefinition getComponentDefinition();
091:
092: /** Returns the UserSession, under which the Component was created
093: * @return The UserSession object
094: */
095: public UserSession getUserSession();
096:
097: /** Getter for property returnToFormKey.
098: * This FormKey determines the screen to display when quitting from a component.
099: * @return Value of property returnToFormKey.
100: */
101: public FormKey getReturnToFormKey();
102:
103: /** Setter for property returnToFormKey.
104: * This FormKey determines the screen to display when quitting from a component.
105: * @param returnToFormKey New value of property returnToFormKey.
106: */
107: public void setReturnToFormKey(FormKey returnToFormKey);
108:
109: /** Getter for property containerFormKey.
110: * This property is useful when this component is being rendered as a tile inside another component.
111: * The outer component is expected to set this property on this component.
112: * The outer component is also expected to register the FormKeyChangeListener on this component.
113: * The ActionBase will intercept all FormKeys for this component. It will then fire the FormKeyChangeEvents on the listeners. The ActionBase will then return the ContainerFormKey.
114: * The Component will fire the FormKeyChangeEvents on the listeners during the quit(), passing the ReturnToFormKey.
115: * All this helps render the tiles correctly.
116: * @return Value of property containerFormKey.
117: *
118: */
119: public FormKey getContainerFormKey();
120:
121: /** Setter for property containerFormKey.
122: * This property is useful when this component is being rendered as a tile inside another component.
123: * The outer component is expected to set this property on this component.
124: * The outer component is also expected to register the FormKeyChangeListener on this component.
125: * The ActionBase will intercept all FormKeys for this component. It will then fire the FormKeyChangeEvents on the listeners. The ActionBase will then return the ContainerFormKey.
126: * The Component will fire the FormKeyChangeEvents on the listeners during the quit(), passing the ReturnToFormKey.
127: * All this helps render the tiles correctly.
128: * @param containerFormKey New value of property containerFormKey.
129: *
130: */
131: public void setContainerFormKey(FormKey containerFormKey);
132:
133: /** Registers listener so that it will receive FormKeyChangeEvents.
134: * The ActionBase typically creates the FormKeyChangeEvent object, when processing an event for a component, that has a ContainerFormKey.
135: * It will then fire the FormKeyChangeListener registered with the component, passing the FormKeyChangeEvent object.
136: * The Component will fire the FormKeyChangeEvents on the listeners during the quit(), passing the ReturnToFormKey.
137: * @param listener the FormKeyChangeListener to register.
138: */
139: public void addFormKeyChangeListener(FormKeyChangeListener listener);
140:
141: /** Unregisters listener so that it will no longer receive FormKeyChangeEvents.
142: * @param listener the FormKeyChangeListener to be removed.
143: */
144: public void removeFormKeyChangeListener(
145: FormKeyChangeListener listener);
146:
147: /** Returns an array of all the FormKeyChangeListeners registered on this component.
148: * @return all of the component's FormKeyChangeListeners or a null if no ancestor listeners are currently registered.
149: */
150: public FormKeyChangeListener[] getFormKeyChangeListeners();
151:
152: /** Returns a true if the component is still active. The component should be set to inactive status after a quit().
153: * @return a true if the component is still active.
154: */
155: public boolean isActive();
156:
157: /** Getter for property token.
158: * @return Value of property token.
159: *
160: */
161: public String getToken();
162:
163: /** Setter for property token.
164: * @param token New value of property token.
165: *
166: */
167: public void setToken(String token);
168:
169: }
|