01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.jetspeed.ajax;
18:
19: import java.util.Map;
20: import org.apache.jetspeed.request.RequestContext;
21:
22: /**
23: * An Ajax request is made up of an action and builder phases.
24: * Implement this interface for the Ajax builder phase.
25: * The builder can add additional information to the requiest context,
26: * and it also provides the template used for building the result stream
27: * sent back over the Ajax request.
28: *
29: * @author <href a="mailto:taylor@apache.org">David Sean Taylor</a>
30: */
31: public interface AjaxBuilder {
32: /**
33: * @return the name of the template used for this builder
34: */
35: public String getTemplate();
36:
37: /**
38: * @return the name of the error template used for this builder
39: */
40: public String getErrorTemplate();
41:
42: /**
43: * Build the normal context template
44: *
45: * @param requestContext The Jetspeed Request Context
46: * @param contextVars Context variables to be substituted into template
47: * @return true on success false onerror
48: */
49: public boolean buildContext(RequestContext requestContext,
50: Map contextVars);
51:
52: /**
53: * Build the error context template
54: *
55: * @param requestContext The Jetspeed Request Context
56: * @param contextVars Context variables to be substituted into template
57: * @return true on success false onerror
58: */
59: public boolean buildErrorContext(RequestContext requestContext,
60: Map contextVars);
61: }
|