001: /*
002: * Copyright 2000-2001,2004 The Apache Software Foundation.
003: *
004: * Licensed under the Apache License, Version 2.0 (the "License");
005: * you may not use this file except in compliance with the License.
006: * You may obtain a copy of the License at
007: *
008: * http://www.apache.org/licenses/LICENSE-2.0
009: *
010: * Unless required by applicable law or agreed to in writing, software
011: * distributed under the License is distributed on an "AS IS" BASIS,
012: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013: * See the License for the specific language governing permissions and
014: * limitations under the License.
015: */
016:
017: /*
018:
019: */
020:
021: package org.apache.wsrp4j.producer.provider;
022:
023: import java.util.HashMap;
024:
025: import oasis.names.tc.wsrp.v1.types.ModelDescription;
026: import oasis.names.tc.wsrp.v1.types.PropertyList;
027:
028: import org.w3c.dom.Element;
029:
030: /**
031: This interface provides access to the portlet's internal state.
032: * @author Stefan Behl
033: *
034: */
035: public interface PortletState {
036:
037: /**
038: * Method getAsString.
039: * @return String
040: */
041: public String getAsString();
042:
043: /**
044: * Method getPortletHandle
045: * @return portletHandle as String
046: */
047: public String getPortletHandle();
048:
049: /**
050: * Method setPortletHandle
051: * @param portletHandle as String
052: */
053: public void setPortletHandle(String portletHandle);
054:
055: /**
056: * Method getAsPropertyList.
057: * @return Iterator
058: */
059: public PropertyList getAsPropertyList();
060:
061: /**
062: * Method setAsString.
063: * @param state
064: */
065: public void setAsString(String state);
066:
067: /**
068: * Method setAsPropertyList.
069: * @param props
070: */
071: public void setAsPropertyList(PropertyList props);
072:
073: /**
074: * Method getAsPropertylist.
075: * @param names
076: */
077: public PropertyList getAsPropertylist(String[] names);
078:
079: /**
080: * Method getAsString.
081: * @param names
082: * @return String
083: */
084: public String getAsString(String[] names);
085:
086: /**
087: * Method setAsElement.
088: * @param props
089: */
090: public void setAsElement(Element props);
091:
092: /**
093: * Method getAsElement.
094: */
095: public Element getAsElement();
096:
097: /**
098: * Method getAsElement.
099: * @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: }
|