01: /**
02: * $Id: WirelessContainerProvider.java,v 1.1 2003/09/22 21:33:56 gregz Exp $
03: * Copyright 2003 Sun Microsystems, Inc. All
04: * rights reserved. Use of this product is subject
05: * to license terms. Federal Acquisitions:
06: * Commercial Software -- Government Users
07: * Subject to Standard License Terms and
08: * Conditions.
09: *
10: * Sun, Sun Microsystems, the Sun logo, and Sun ONE
11: * are trademarks or registered trademarks of Sun Microsystems,
12: * Inc. in the United States and other countries.
13: */package com.sun.portal.wireless.providers.containers;
14:
15: import com.sun.portal.providers.containers.ContainerProvider;
16: import com.sun.portal.providers.ProviderException;
17:
18: import javax.servlet.http.HttpServletRequest;
19: import java.util.List;
20:
21: /**
22: * <code>WirelessContainerProvider</code> defines the interface for
23: * implementing a container provider on the wireless desktop.
24: *
25: * <code>WirelessContainerProvider</code> overloads the <code>getAvailable</code>
26: * method and introduces <code>getOrderedSelectedChannels</code> method for
27: * implementations specific to the wireless desktop.
28: *
29: * @see com.sun.portal.providers.containers.ContainerProvider
30: */
31: public interface WirelessContainerProvider extends ContainerProvider {
32:
33: /**
34: * Gets the list of available channel names.
35: * @param request HttpServletRequest
36: * @return The list of available channel names, a list of string names.
37: * @throws ProviderException
38: */
39: public List getAvailableChannels(HttpServletRequest request)
40: throws ProviderException;
41:
42: /**
43: * Gets the list of available channel names.
44: * @param request HttpServletRequest
45: * @param onlyRemovable indicate to include only removable channels.
46: * @return The list of available channel names, a list of string names.
47: * @throws ProviderException
48: */
49: public List getAvailableChannels(HttpServletRequest request,
50: boolean onlyRemovable) throws ProviderException;
51:
52: /**
53: * Gets the ordered list of selected channel names.
54: * @param request HttpServletRequest
55: * @return The ordered list of selected channel names, a list of string names.
56: * @throws ProviderException
57: */
58: public List getOrderedSelectedChannels(HttpServletRequest request)
59: throws ProviderException;
60:
61: /**
62: * Gets the ordered list of selected channel names.
63: * @param request HttpServletRequest
64: * @param onlyMovable indicate to include only movable channels.
65: * @return The ordered list of selected channel names, a list of string names.
66: * @throws ProviderException
67: */
68: public List getOrderedSelectedChannels(HttpServletRequest request,
69: boolean onlyMovable) throws ProviderException;
70: }
|