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.container.state.impl;
18  
19  import java.io.UnsupportedEncodingException;
20  import java.util.Map;
21  
22  import javax.portlet.PortletMode;
23  import javax.portlet.WindowState;
24  
25  import org.apache.pluto.om.window.PortletWindow;
26  
27  public interface NavigationalStateCodec
28  {
29      PortletWindowRequestNavigationalStates decode(String parameters, String characterEncoding) throws UnsupportedEncodingException;
30  
31      String encode(PortletWindowRequestNavigationalStates states, PortletWindow window, PortletMode portletMode,
32              WindowState windowState, boolean navParamsStateFull, boolean renderParamsStateFull) throws UnsupportedEncodingException;
33  
34      String encode(PortletWindowRequestNavigationalStates states, PortletWindow window, Map parameters,
35              PortletMode portletMode, WindowState windowState, boolean action, boolean navParamsStateFull, 
36              boolean renderParamsStateFull) throws UnsupportedEncodingException;
37  
38      String encode(PortletWindowRequestNavigationalStates states, boolean navParamsStateFull, boolean renderParamsStateFull) 
39              throws UnsupportedEncodingException;
40  }