PropertyUpdateProcessor


1   /* 
2    * This file is part of the Echo Web Application Framework (hereinafter "Echo").
3    * Copyright (C) 2002-2005 NextApp, Inc.
4    *
5    * Version: MPL 1.1/GPL 2.0/LGPL 2.1
6    *
7    * The contents of this file are subject to the Mozilla Public License Version
8    * 1.1 (the "License"); you may not use this file except in compliance with
9    * the License. You may obtain a copy of the License at
10   * http://www.mozilla.org/MPL/
11   *
12   * Software distributed under the License is distributed on an "AS IS" basis,
13   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
14   * for the specific language governing rights and limitations under the
15   * License.
16   *
17   * Alternatively, the contents of this file may be used under the terms of
18   * either the GNU General Public License Version 2 or later (the "GPL"), or
19   * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
20   * in which case the provisions of the GPL or the LGPL are applicable instead
21   * of those above. If you wish to allow use of your version of this file only
22   * under the terms of either the GPL or the LGPL, and not to allow others to
23   * use your version of this file under the terms of the MPL, indicate your
24   * decision by deleting the provisions above and replace them with the notice
25   * and other provisions required by the GPL or the LGPL. If you do not delete
26   * the provisions above, a recipient may use your version of this file under
27   * the terms of any one of the MPL, the GPL or the LGPL.
28   */
29  
30  package nextapp.echo2.webcontainer;
31  
32  import org.w3c.dom.Element  ;
33  
34  import nextapp.echo2.app.Component;
35  
36  /**
37   * An optional interface for <code>ComponentSynchronizePeer</code>s that provides
38   * the capability to receive <strong>DELAYED</strong> notification of
39   * state updates from the client.   The delayed state notifications will
40   * be provided to the server when a state change occurs to a component
41   * which requires immediate notification.  The delayed state notifications
42   * will be provided to the application before the immediate notification,
43   * though they will be processed in no particular order.
44   * This interface must be implemented by any component that creates
45   * "EchoPropertyUpdate" message parts on the client in a ClientMessage.
46   * 
47   * @see nextapp.echo2.webcontainer.ActionProcessor
48   */
49  public interface PropertyUpdateProcessor {
50      
51      /**
52       * The attribute name of XML 'property' elements that specifies
53       * the name of the property.
54       */
55      public String   PROPERTY_NAME = "name";
56  
57      /**
58       * The attribute name of XML 'property' elements that specifies
59       * the value of the property.  Property elements may instead
60       * pass property data in child XML elements, and in such cases
61       * should not have a 'value' attribute.
62       */
63      public String   PROPERTY_VALUE = "value";
64      
65      /**
66       * Notifies the <code>ComponentSynchronizePeer</code> that a client property 
67       * update has occurred.
68       * 
69       * @param ci the relevant <code>ContainerInstance</code>
70       * @param component the target <code>Component</code>
71       * @param propertyElement the XML element describing the property update
72       *        (the name and value of the changed property may be obtained
73       *        by querying the <code>PROPERTY_NAME</code> and 
74       *        <code>PROPERTY_VALUE</code> attribute values. 
75       */
76      public void processPropertyUpdate(ContainerInstance ci, Component component, Element   propertyElement);
77  }
78
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags