| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.5.0) on Fri May 16 17:07:38 EDT 2008 --> |
| <TITLE> |
| IPolicyState |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.ws.service.policy.IPolicyState interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="IPolicyState"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IPolicyState.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IPolicyRelationship.html" title="interface in org.eclipse.wst.ws.service.policy"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IPolicyStateEnum.html" title="interface in org.eclipse.wst.ws.service.policy"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/eclipse/wst/ws/service/policy/IPolicyState.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IPolicyState.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <A NAME="main"></A> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.eclipse.wst.ws.service.policy</FONT> |
| <BR> |
| Interface IPolicyState</H2> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>IPolicyState</B></DL> |
| </PRE> |
| |
| <P> |
| This interface is used by service policy extenders to save the state of |
| there policies. Note: extenders do not need to worry about if these changes |
| are committed or discarded. This is handled by the framework. For example |
| if an extender makes a number of calls to the putValue method and at some |
| point ServicePolicyPlatform.discard() is called, the framework will handle |
| the discarding of the changes made by the putValue method calls. |
| |
| Note: this data will eventually be stored in Eclipse with the following key: |
| |
| servicePolicyId + "." + key |
| |
| where servicePolicyId is the unique id for this service policy and the key |
| is the key specified in the putValue method. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IPolicyState.html#DefaultValueKey">DefaultValueKey</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IPolicyState.html#addPolicyStateChangeListener(org.eclipse.wst.ws.service.policy.listeners.IPolicyStateChangeListener, boolean)">addPolicyStateChangeListener</A></B>(<A HREF="../../../../../../org/eclipse/wst/ws/service/policy/listeners/IPolicyStateChangeListener.html" title="interface in org.eclipse.wst.ws.service.policy.listeners">IPolicyStateChangeListener</A> listener, |
| boolean notifyOnlyOnCommit)</CODE> |
| |
| <BR> |
| Adds a policy state change listener to this service policy.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IPolicyState.html#getValue(java.lang.String)">getValue</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| This method gets some state for a service policy.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IPolicyState.html#isMutable()">isMutable</A></B>()</CODE> |
| |
| <BR> |
| Returns whether the state of this policy is mutible or not.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IPolicyState.html#putDefaultValue(java.lang.String, java.lang.String, boolean)">putDefaultValue</A></B>(java.lang.String key, |
| java.lang.String defaultValue, |
| boolean overrideExisting)</CODE> |
| |
| <BR> |
| This method sets the default for a particular key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IPolicyState.html#putValue(java.lang.String, java.lang.String)">putValue</A></B>(java.lang.String key, |
| java.lang.String value)</CODE> |
| |
| <BR> |
| This method sets some state for a service policy.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IPolicyState.html#removePolicyStateChangeListener(org.eclipse.wst.ws.service.policy.listeners.IPolicyStateChangeListener)">removePolicyStateChangeListener</A></B>(<A HREF="../../../../../../org/eclipse/wst/ws/service/policy/listeners/IPolicyStateChangeListener.html" title="interface in org.eclipse.wst.ws.service.policy.listeners">IPolicyStateChangeListener</A> listener)</CODE> |
| |
| <BR> |
| Removes a policy state change listener from this service policy.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IPolicyState.html#setMutable(boolean)">setMutable</A></B>(boolean mutable)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="DefaultValueKey"><!-- --></A><H3> |
| DefaultValueKey</H3> |
| <PRE> |
| static final java.lang.String <B>DefaultValueKey</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.eclipse.wst.ws.service.policy.IPolicyState.DefaultValueKey">Constant Field Values</A></DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="isMutable()"><!-- --></A><H3> |
| isMutable</H3> |
| <PRE> |
| boolean <B>isMutable</B>()</PRE> |
| <DL> |
| <DD>Returns whether the state of this policy is mutible or not. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>returns true if the state of this policy is mutable.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setMutable(boolean)"><!-- --></A><H3> |
| setMutable</H3> |
| <PRE> |
| void <B>setMutable</B>(boolean mutable)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>mutable</CODE> - sets whether this policy is mutable or not. Note: |
| if the service policy for this IPolicyState object is predefined calling |
| this method will have no effect.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="putValue(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| putValue</H3> |
| <PRE> |
| void <B>putValue</B>(java.lang.String key, |
| java.lang.String value)</PRE> |
| <DL> |
| <DD>This method sets some state for a service policy. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - a key for this policy state.<DD><CODE>value</CODE> - the value of the policy state.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getValue(java.lang.String)"><!-- --></A><H3> |
| getValue</H3> |
| <PRE> |
| java.lang.String <B>getValue</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD>This method gets some state for a service policy. If there |
| is no persisted value for this key the default value will be |
| returned. If there is no default value an empty string is returned. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - a key for this service policy. |
| <DT><B>Returns:</B><DD>returns the value for the key specified.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="putDefaultValue(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3> |
| putDefaultValue</H3> |
| <PRE> |
| void <B>putDefaultValue</B>(java.lang.String key, |
| java.lang.String defaultValue, |
| boolean overrideExisting)</PRE> |
| <DL> |
| <DD>This method sets the default for a particular key. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the key<DD><CODE>defaultValue</CODE> - the default value.<DD><CODE>overrideExisting</CODE> - indicates if a existing default value should be overridden.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addPolicyStateChangeListener(org.eclipse.wst.ws.service.policy.listeners.IPolicyStateChangeListener, boolean)"><!-- --></A><H3> |
| addPolicyStateChangeListener</H3> |
| <PRE> |
| void <B>addPolicyStateChangeListener</B>(<A HREF="../../../../../../org/eclipse/wst/ws/service/policy/listeners/IPolicyStateChangeListener.html" title="interface in org.eclipse.wst.ws.service.policy.listeners">IPolicyStateChangeListener</A> listener, |
| boolean notifyOnlyOnCommit)</PRE> |
| <DL> |
| <DD>Adds a policy state change listener to this service policy. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener<DD><CODE>notifyOnlyOnCommit</CODE> - indicates if this listener should be |
| called for all state changes or only when the state data is |
| committed.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removePolicyStateChangeListener(org.eclipse.wst.ws.service.policy.listeners.IPolicyStateChangeListener)"><!-- --></A><H3> |
| removePolicyStateChangeListener</H3> |
| <PRE> |
| void <B>removePolicyStateChangeListener</B>(<A HREF="../../../../../../org/eclipse/wst/ws/service/policy/listeners/IPolicyStateChangeListener.html" title="interface in org.eclipse.wst.ws.service.policy.listeners">IPolicyStateChangeListener</A> listener)</PRE> |
| <DL> |
| <DD>Removes a policy state change listener from this service policy. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>listener</CODE> - </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IPolicyState.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IPolicyRelationship.html" title="interface in org.eclipse.wst.ws.service.policy"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IPolicyStateEnum.html" title="interface in org.eclipse.wst.ws.service.policy"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/eclipse/wst/ws/service/policy/IPolicyState.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IPolicyState.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
