01: /*
02: ItsNat Java Web Application Framework
03: Copyright (C) 2007 Innowhere Software Services S.L., Spanish Company
04: Author: Jose Maria Arranz Santamaria
05:
06: This program is free software: you can redistribute it and/or modify
07: it under the terms of the GNU Affero General Public License as published by
08: the Free Software Foundation, either version 3 of the License, or
09: (at your option) any later version. See the GNU Affero General Public
10: License for more details. See the copy of the GNU Affero General Public License
11: included in this program. If not, see <http://www.gnu.org/licenses/>.
12: */
13:
14: package org.itsnat.core.event;
15:
16: /**
17: * This event object is sent to registered {@link RemoteControlEventListener} objects
18: * to notify the several phases of a remote control process using a timer
19: * to notify the client any document change.
20: *
21: * @author Jose Maria Arranz Santamaria
22: */
23: public interface RemoteControlTimerEvent extends RemoteControlEvent {
24: /**
25: * Returns the refresh interval. If this event is a {@link RemoteControlEvent#REQUEST}
26: * returned value may be used to validate the request.
27: *
28: * <p>Returned value is proposed initially by the client but can not change
29: * during the remote control life cycle. If a new remote control request
30: * was accepted use this value to verify if the accepted
31: * refresh interval is the same or lower than the real interval between events
32: * (to detect some kind of client manipulation and avoid a server overload).</p>
33: *
34: * @return the refresh interval.
35: * @see #setAccepted(boolean)
36: */
37: public int getRefreshInterval();
38: }
|