View Javadoc

1   /*
2    * Copyright 2003,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
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   */
16  
17  package org.apache.pluto.services.title;
18  
19  import javax.servlet.http.HttpServletRequest;
20  
21  import org.apache.pluto.om.window.PortletWindow;
22  import org.apache.pluto.services.ContainerService;
23  
24  /***
25   * The interfaces defined in this package represent an abstract object
26   * model (OM) that is applicable for different implementations.
27   * <P>
28   * This abstraction layer helps to generalize the portlet container from
29   * special implementations like data storage and moreover it is not bound
30   * to a special implementation.
31   * 
32   **/
33  public interface DynamicTitleService extends ContainerService 
34  {
35  
36      /***
37       * Sets all properties of the given map to the portlet response.
38       * 
39       * @param window the portlet window 
40       * @param dynamicTitle the string containing the dynamic title. NULL will reset the title to the default one.
41       **/
42      public void setDynamicTitle(PortletWindow window,
43                                  HttpServletRequest request,
44                                  String dynamicTitle);
45  
46  }