KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > pluto > services > information > PortletURLProvider


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
18  */
19
20 package org.apache.pluto.services.information;
21
22 import java.util.Map JavaDoc;
23
24 import javax.portlet.PortletMode;
25 import javax.portlet.WindowState;
26
27 public interface PortletURLProvider
28 {
29
30
31      /**
32       * Sets the new portlet mode at the URL. If no
33       * mode is set at the URL the currently active
34       * mode is used.
35       *
36       * @param mode the new portlet mode
37       */
38      public void setPortletMode(PortletMode mode);
39
40      /**
41       * Sets the new window state at the URL. If no
42       * state is set at the URL the currently active
43       * state is used.
44       *
45       * @param state the new window state
46       */
47      public void setWindowState(WindowState state);
48
49      /**
50       * By calling this method the URL is defined as
51       * an action URL. If this URL is execute the
52       * action() method will be called at the
53       * portlet entity linked with the URL.
54       */
55      public void setAction();
56
57      /**
58       * By calling this method the URL is defined as
59       * a secure URL.
60       */
61      public void setSecure();
62
63      /**
64       * Removes all pre-existing parameters in this URL
65       */
66      public void clearParameters();
67
68      /**
69       * Sets the given parameters as parameters into the URL,
70       * Removes all previously set parameters.
71       *
72       * @param parameters a map containing the name [java.lang.String] and value [java.lang.String[]] of the parameters.
73       */
74      public void setParameters(Map JavaDoc parameters);
75
76
77      /**
78       * Returns the URL in string format. This method should only be called once.
79       *
80       * @return the URL
81       */
82      public String JavaDoc toString();
83 }
84
Popular Tags