PortletState.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.producer.provider; 22 23 import java.util.HashMap; 24 25 import oasis.names.tc.wsrp.v1.types.ModelDescription; 26 import oasis.names.tc.wsrp.v1.types.PropertyList; 27 28 import org.w3c.dom.Element; 29 30 /** 31 This interface provides access to the portlet's internal state. 32 * @author Stefan Behl 33 * 34 */ 35 public interface PortletState { 36 37 /** 38 * Method getAsString. 39 * @return String 40 */ 41 public String getAsString(); 42 43 /** 44 * Method getPortletHandle 45 * @return portletHandle as String 46 */ 47 public String getPortletHandle(); 48 49 /** 50 * Method setPortletHandle 51 * @param portletHandle as String 52 */ 53 public void setPortletHandle(String portletHandle); 54 55 /** 56 * Method getAsPropertyList. 57 * @return Iterator 58 */ 59 public PropertyList getAsPropertyList(); 60 61 /** 62 * Method setAsString. 63 * @param state 64 */ 65 public void setAsString(String state); 66 67 /** 68 * Method setAsPropertyList. 69 * @param props 70 */ 71 public void setAsPropertyList(PropertyList props); 72 73 /** 74 * Method getAsPropertylist. 75 * @param names 76 */ 77 public PropertyList getAsPropertylist(String[] names); 78 79 /** 80 * Method getAsString. 81 * @param names 82 * @return String 83 */ 84 public String getAsString(String[] names); 85 86 /** 87 * Method setAsElement. 88 * @param props 89 */ 90 public void setAsElement(Element props); 91 92 /** 93 * Method getAsElement. 94 */ 95 public Element getAsElement(); 96 97 /** 98 * Method getAsElement. 99 * @param names 100 */ 101 public Element getAsElement(String[] names); 102 103 /** 104 * Return the Property map 105 * @return HashMap 106 */ 107 public HashMap getPropertyMap(); 108 109 /** 110 * Set the Property map 111 * @param propertyMap properties 112 */ 113 public void setPropertyMap(HashMap propertyMap); 114 115 /** 116 Set the WSRP model description 117 @param modelDescription WSRP model description 118 */ 119 public void setModelDescription(ModelDescription modelDescription); 120 121 /** 122 Return the WSRP model description 123 @return ModelDescription 124 */ 125 public ModelDescription getModelDescription(); 126 127 }