View Javadoc

1   /*
2    * $Id: PortletPreferencesAware.java 502294 2007-02-01 17:28:00Z niallp $
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  package org.apache.struts2.portlet.interceptor;
22  
23  import javax.portlet.PortletPreferences;
24  
25  
26  /***
27   * All Actions that want to have access to the portlet preferences should
28   * implement this interface.  If running in a servlet environment, an
29   * appropriate testing implementation will be provided.
30   */
31  public interface PortletPreferencesAware {
32  
33      /***
34       * Sets the HTTP request object in implementing classes.
35       *
36       * @param request the HTTP request.
37       */
38      public void setPortletPreferences(PortletPreferences prefs);
39  }