01: /* $Id: EventRequest.java,v 1.2 2005/07/29 03:52:38 vs152012 Exp $
02: * Copyright 2004-2005 Sun Microsystems, Inc. All rights reserved.
03: * Use is subject to license terms.
04: */
05: package com.sun.portal.portletappengine.ipc;
06:
07: import javax.portlet.PortletRequest;
08: import java.io.InputStream;
09:
10: /**
11: * EventRequest interface is used for obtaining the information about event
12: * (i.e. event name and data).
13: * This interface provides two ways of getting the event data: (1) An Object
14: * instance using getEventData method or (2) An InputStream using
15: * getEventStream method. Event data can be obtained by reading from the
16: * stream.
17: */
18: public interface EventRequest extends PortletRequest {
19:
20: /**
21: * Method to obtain the event name
22: * @return String containing the name of the event
23: */
24: public String getEventName();
25:
26: /**
27: * Method to obtain the InputStream from which event data can be obtained.
28: * @return An instance of InputStream
29: */
30: public InputStream getEventStream();
31:
32: /**
33: * Method to obtain the event data object
34: * @return An object containing the event data
35: */
36: public Object getEventData();
37: }
|