01: /**
02: * Copyright 2006 Webmedia Group Ltd.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: **/package org.araneaframework.http;
16:
17: import java.io.Serializable;
18: import java.util.Map;
19:
20: /**
21: * A way to pass custom data back to client-side via AJAX requests.
22: *
23: * @author Alar Kvell (alar@araneaframework.org)
24: * @since 1.1
25: */
26: public interface UpdateRegionProvider extends Serializable {
27:
28: /**
29: * Will be called only when updateregion filter is activated on AJAX requests.
30: *
31: * @return map containing regions that will be passed to client-side. Map must
32: * have region names as <code>String</code> keys and region contents
33: * as <code>String</code> values. Region contents will be passed to
34: * client-side Javascript region handler, designated by region name.
35: * May return <code>null</code> or empty map. If map contains a
36: * <code>null</code> value, then that region is not included in
37: * response.
38: */
39: Map getRegions();
40:
41: }
|