View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      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 org.apache.jetspeed.request.RequestContext;
20  import java.util.Map;
21  
22  /***
23   * An Ajax request is made up of an action and builder phases.
24   * Implement this interface for the Ajax action phase.
25   * The action should put any parameters or results it wants 
26   * passed on to the builders in the resultMap
27   *
28   * @author <href a="mailto:taylor@apache.org">David Sean Taylor</a>
29   */
30  public interface AjaxAction
31  {
32  	 
33      /***
34       * The action should put any parameters or results it wants 
35       * passed on to the builders in the resultMap
36       * This method runs an Ajax action.
37       *  
38       * @param requestContext The Jetspeed Request Context
39       * @param resultMap map of action parameters passed to the builder context
40       * @return success is true, failure is false
41       * @throws Exception
42       */
43      public boolean run(RequestContext requestContext, Map resultMap) throws AJAXException;
44  
45      /***
46       * Same as run method, but runs in batch mode, as a hint to the action
47       * that it is running a multiple action and can delay its update
48       * runBatch currently supports pageManager.updatePage
49       *  
50       * @param requestContext The Jetspeed Request Context
51       * @param resultMap map of action parameters passed to the builder context
52       * @return success is true, failure is false
53       * @throws Exception
54       */    
55      public boolean runBatch(RequestContext requestContext, Map resultMap) throws AJAXException;
56      
57      /***
58       * Checks to see if the current subject has access to to execute this action.
59       * 
60       * @param context
61       * @return true if access granted, false if denied.
62       */
63      public boolean checkAccess(RequestContext context, String action);
64      
65  }