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.pluto.spi.optional;
18:
19: import javax.portlet.PortletRequest;
20:
21: import org.apache.pluto.PortletWindow;
22: import org.apache.pluto.PortletContainerException;
23: import org.apache.pluto.internal.InternalPortletPreference;
24: import org.apache.pluto.spi.ContainerService;
25:
26: /**
27: * Portlet preferences service that should be implemented by the portal.
28: * This is an optional container service.
29: *
30: */
31: public interface PortletPreferencesService extends ContainerService {
32:
33: /**
34: * Returns the stored portlet preferences.
35: * @param portletWindow the portlet window.
36: * @param request the portlet request.
37: * @return the stored portlet preferences.
38: * @throws PortletContainerException if fail to get stored preferences.
39: */
40: public InternalPortletPreference[] getStoredPreferences(
41: PortletWindow portletWindow, PortletRequest request)
42: throws PortletContainerException;
43:
44: /**
45: * Stores the portlet references to the persistent storage.
46: * @param portletWindow the portlet window.
47: * @param request the portlet request.
48: * @param preferences the portlet preferences to store.
49: * @throws PortletContainerException if fail to store preferences.
50: */
51: public void store(PortletWindow portletWindow,
52: PortletRequest request,
53: InternalPortletPreference[] preferences)
54: throws PortletContainerException;
55:
56: }
|