PortletKey.java |
1 /* 2 * Copyright 2000-2001,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 21 package org.apache.wsrp4j.consumer; 22 23 /** 24 * Defines the information which uniquely identifies an portlet provided by a producer. 25 * The portlet key does not identify a use of an portlet 26 * 27 * @author <a href='mailto:Stephan.Laertz@de.ibm.com'>Stephan Laertz</a> 28 **/ 29 public interface PortletKey { 30 31 /** 32 * Get the portlet handle which identifies an portlet in the scope of one producer 33 * 34 * @return The portlet handle 35 **/ 36 public String getPortletHandle(); 37 38 /** 39 * Set the portlet handle which identifies an portlet in the scope of one producer 40 * 41 * @param portletHandle The portlet handle 42 **/ 43 public void setPortletHandle(String portletHandle); 44 45 /** 46 * Get the ID of the producer providing the portlet 47 * 48 * @return The ID of the producer 49 **/ 50 public String getProducerId(); 51 52 /** 53 * Set the ID of the producer providing the portlet 54 * 55 * @param id The ID of the producer 56 **/ 57 public void setProducerId(String id); 58 }