1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package javax.faces.context;
20
21 import java.util.Collection;
22
23 import javax.faces.event.PhaseId;
24
25 /**
26 * @author Simon Lessard (latest modification by $Author: bommel $)
27 * @version $Revision: 1187701 $ $Date: 2011-10-22 07:21:54 -0500 (Sat, 22 Oct 2011) $
28 *
29 * @since 2.0
30 */
31 public abstract class PartialViewContext
32 {
33 public static final String ALL_PARTIAL_PHASE_CLIENT_IDS = "@all";
34 //public static final String NO_PARTIAL_PHASE_CLIENT_IDS = "@none";
35 public static final String PARTIAL_EXECUTE_PARAM_NAME = "javax.faces.partial.execute";
36 public static final String PARTIAL_RENDER_PARAM_NAME = "javax.faces.partial.render";
37
38 public abstract Collection<String> getExecuteIds();
39
40 public abstract PartialResponseWriter getPartialResponseWriter();
41
42 public abstract Collection<String> getRenderIds();
43
44 public abstract boolean isAjaxRequest();
45
46 public abstract boolean isExecuteAll();
47
48 public abstract boolean isPartialRequest();
49
50 public abstract boolean isRenderAll();
51
52 public abstract void processPartial(PhaseId phaseId);
53
54 public abstract void release();
55
56 public abstract void setPartialRequest(boolean isPartialRequest);
57
58 public abstract void setRenderAll(boolean renderAll);
59 }