diff options
| author | pmoogk | 2008-05-13 20:53:11 +0000 |
|---|---|---|
| committer | pmoogk | 2008-05-13 20:53:11 +0000 |
| commit | a8c9b0abad8c6034c59d455084ecadfdcff48b96 (patch) | |
| tree | ad43ad5c23c79356e693b064ba80f97938f92376 /docs/org.eclipse.wst.ws.api.doc/reference/api/org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html | |
| parent | a8abc40fea62099c3c4618672dcfa8b53d797e3a (diff) | |
| download | webtools.webservices-a8c9b0abad8c6034c59d455084ecadfdcff48b96.tar.gz webtools.webservices-a8c9b0abad8c6034c59d455084ecadfdcff48b96.tar.xz webtools.webservices-a8c9b0abad8c6034c59d455084ecadfdcff48b96.zip | |
[231383] Creation of org.eclipse.wst.api.doc
Diffstat (limited to 'docs/org.eclipse.wst.ws.api.doc/reference/api/org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html')
| -rw-r--r-- | docs/org.eclipse.wst.ws.api.doc/reference/api/org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html | 706 |
1 files changed, 706 insertions, 0 deletions
diff --git a/docs/org.eclipse.wst.ws.api.doc/reference/api/org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html b/docs/org.eclipse.wst.ws.api.doc/reference/api/org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html new file mode 100644 index 000000000..94ec1b59f --- /dev/null +++ b/docs/org.eclipse.wst.ws.api.doc/reference/api/org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html @@ -0,0 +1,706 @@ +<!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 Tue May 13 15:32:21 EDT 2008 --> +<TITLE> +ServicePolicyPlatform +</TITLE> + +<META NAME="keywords" CONTENT="org.eclipse.wst.ws.service.policy.ServicePolicyPlatform class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="ServicePolicyPlatform"; +} +</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/ServicePolicyPlatform.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/ServicePolicyActivator.html" title="class in org.eclipse.wst.ws.service.policy"><B>PREV CLASS</B></A> + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../../index.html?org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html" target="_top"><B>FRAMES</B></A> + <A HREF="ServicePolicyPlatform.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | 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> +Class ServicePolicyPlatform</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.ws.service.policy.ServicePolicyPlatform</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>ServicePolicyPlatform</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +This class is used to access and add service policies to the platform. +<P> + +<P> +<HR> + +<P> + +<!-- ========== 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/ServicePolicyPlatform.html#addChildChangeListener(org.eclipse.wst.ws.service.policy.listeners.IPolicyChildChangeListener, boolean)">addChildChangeListener</A></B>(org.eclipse.wst.ws.service.policy.listeners.IPolicyChildChangeListener listener, + boolean onCommit)</CODE> + +<BR> + This method allows calls to listener to any child change that is + made in the service policy platform regardless of where it is + located in the tree of service policies.</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/ServicePolicyPlatform.html#addProjectLoadListener(org.eclipse.wst.ws.service.policy.listeners.IPolicyPlatformProjectLoadListener)">addProjectLoadListener</A></B>(org.eclipse.wst.ws.service.policy.listeners.IPolicyPlatformProjectLoadListener listener)</CODE> + +<BR> + Add a project platform listener.</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/ServicePolicyPlatform.html#commitChanges()">commitChanges</A></B>()</CODE> + +<BR> + Calling this method will commit all the state changes that were made to all + the service policies.</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/ServicePolicyPlatform.html#commitChanges(org.eclipse.core.resources.IProject)">commitChanges</A></B>(org.eclipse.core.resources.IProject project)</CODE> + +<BR> + Calling this method will commit all the state changes that were made to all + the service policies for a particular project.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IServicePolicy.html" title="interface in org.eclipse.wst.ws.service.policy">IServicePolicy</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html#createServicePolicy(org.eclipse.wst.ws.service.policy.IServicePolicy, java.lang.String, java.lang.String, java.lang.String)">createServicePolicy</A></B>(<A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IServicePolicy.html" title="interface in org.eclipse.wst.ws.service.policy">IServicePolicy</A> parent, + java.lang.String id, + java.lang.String enumListId, + java.lang.String defaultEnumId)</CODE> + +<BR> + This method creates an IServicePolicy object.</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/ServicePolicyPlatform.html#discardChanges()">discardChanges</A></B>()</CODE> + +<BR> + Calling this method will discard all the state changes that were made to all + the service policies.</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/ServicePolicyPlatform.html#discardChanges(org.eclipse.core.resources.IProject)">discardChanges</A></B>(org.eclipse.core.resources.IProject project)</CODE> + +<BR> + Calling this method will discard all the state changes that were made to all + the service policies for a particular project.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Set<java.lang.String></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html#getAllPolicyIds()">getAllPolicyIds</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../../../../../org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html" title="class in org.eclipse.wst.ws.service.policy">ServicePolicyPlatform</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html#getInstance()">getInstance</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.List<<A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IServicePolicy.html" title="interface in org.eclipse.wst.ws.service.policy">IServicePolicy</A>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html#getRootServicePolicies(org.eclipse.wst.ws.service.policy.IFilter)">getRootServicePolicies</A></B>(<A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IFilter.html" title="interface in org.eclipse.wst.ws.service.policy">IFilter</A> filter)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IServicePolicy.html" title="interface in org.eclipse.wst.ws.service.policy">IServicePolicy</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html#getServicePolicy(java.lang.String)">getServicePolicy</A></B>(java.lang.String id)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.List<<A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IStateEnumerationItem.html" title="interface in org.eclipse.wst.ws.service.policy">IStateEnumerationItem</A>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html#getStateEnumeration(java.lang.String)">getStateEnumeration</A></B>(java.lang.String enumId)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IStateEnumerationItem.html" title="interface in org.eclipse.wst.ws.service.policy">IStateEnumerationItem</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html#getStateItemEnumeration(java.lang.String)">getStateItemEnumeration</A></B>(java.lang.String stateItemId)</CODE> + +<BR> + </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/ServicePolicyPlatform.html#isEnabled(java.lang.Object)">isEnabled</A></B>(java.lang.Object object)</CODE> + +<BR> + </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/ServicePolicyPlatform.html#isProjectPreferencesEnabled(org.eclipse.core.resources.IProject)">isProjectPreferencesEnabled</A></B>(org.eclipse.core.resources.IProject project)</CODE> + +<BR> + </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/ServicePolicyPlatform.html#queueChildChangeListeners(boolean)">queueChildChangeListeners</A></B>(boolean queue)</CODE> + +<BR> + </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/ServicePolicyPlatform.html#removeChildChangeListener(org.eclipse.wst.ws.service.policy.listeners.IPolicyChildChangeListener, boolean)">removeChildChangeListener</A></B>(org.eclipse.wst.ws.service.policy.listeners.IPolicyChildChangeListener listener, + boolean onCommit)</CODE> + +<BR> + Removes a child change listener from the service policy platform.</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/ServicePolicyPlatform.html#removeProjectLoadListener(org.eclipse.wst.ws.service.policy.listeners.IPolicyPlatformProjectLoadListener)">removeProjectLoadListener</A></B>(org.eclipse.wst.ws.service.policy.listeners.IPolicyPlatformProjectLoadListener listener)</CODE> + +<BR> + Removes a project platform listener.</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/ServicePolicyPlatform.html#removeServicePolicy(org.eclipse.wst.ws.service.policy.IServicePolicy)">removeServicePolicy</A></B>(<A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IServicePolicy.html" title="interface in org.eclipse.wst.ws.service.policy">IServicePolicy</A> policy)</CODE> + +<BR> + Removes a service policy from the service policy platform.</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/ServicePolicyPlatform.html#restoreDefaults()">restoreDefaults</A></B>()</CODE> + +<BR> + Restores the workspace level defaults.</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/ServicePolicyPlatform.html#restoreDefaults(org.eclipse.core.resources.IProject)">restoreDefaults</A></B>(org.eclipse.core.resources.IProject project)</CODE> + +<BR> + Restores the project level defaults.</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/ServicePolicyPlatform.html#setProjectPreferencesEnabled(org.eclipse.core.resources.IProject, boolean)">setProjectPreferencesEnabled</A></B>(org.eclipse.core.resources.IProject project, + boolean value)</CODE> + +<BR> + Sets whether project specific service policy preferences is enabled or not.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ 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="getInstance()"><!-- --></A><H3> +getInstance</H3> +<PRE> +public static <A HREF="../../../../../../org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html" title="class in org.eclipse.wst.ws.service.policy">ServicePolicyPlatform</A> <B>getInstance</B>()</PRE> +<DL> +<DD><DL> + +<DT><B>Returns:</B><DD>returns a singleton instance of this service policy platform.</DL> +</DD> +</DL> +<HR> + +<A NAME="isEnabled(java.lang.Object)"><!-- --></A><H3> +isEnabled</H3> +<PRE> +public boolean <B>isEnabled</B>(java.lang.Object object)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>object</CODE> - +<DT><B>Returns:</B><DD>returns true if this platform is enabled for specified object. In most + cases the specified object will be an IProject. This method is usually called + to determine if a the service policy entry should appear for a particular project.</DL> +</DD> +</DL> +<HR> + +<A NAME="commitChanges()"><!-- --></A><H3> +commitChanges</H3> +<PRE> +public void <B>commitChanges</B>()</PRE> +<DL> +<DD>Calling this method will commit all the state changes that were made to all + the service policies. The method only applies to state changes at the workspace + level. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="discardChanges()"><!-- --></A><H3> +discardChanges</H3> +<PRE> +public void <B>discardChanges</B>()</PRE> +<DL> +<DD>Calling this method will discard all the state changes that were made to all + the service policies. The method only applies to state changes at the workspace + level. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="commitChanges(org.eclipse.core.resources.IProject)"><!-- --></A><H3> +commitChanges</H3> +<PRE> +public void <B>commitChanges</B>(org.eclipse.core.resources.IProject project)</PRE> +<DL> +<DD>Calling this method will commit all the state changes that were made to all + the service policies for a particular project. The method only applies to + state changes at the project level. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="discardChanges(org.eclipse.core.resources.IProject)"><!-- --></A><H3> +discardChanges</H3> +<PRE> +public void <B>discardChanges</B>(org.eclipse.core.resources.IProject project)</PRE> +<DL> +<DD>Calling this method will discard all the state changes that were made to all + the service policies for a particular project. The method only applies to + state changes at the project level. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getAllPolicyIds()"><!-- --></A><H3> +getAllPolicyIds</H3> +<PRE> +public java.util.Set<java.lang.String> <B>getAllPolicyIds</B>()</PRE> +<DL> +<DD><DL> + +<DT><B>Returns:</B><DD>returns all service policy IDs that are defined.</DL> +</DD> +</DL> +<HR> + +<A NAME="getRootServicePolicies(org.eclipse.wst.ws.service.policy.IFilter)"><!-- --></A><H3> +getRootServicePolicies</H3> +<PRE> +public java.util.List<<A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IServicePolicy.html" title="interface in org.eclipse.wst.ws.service.policy">IServicePolicy</A>> <B>getRootServicePolicies</B>(<A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IFilter.html" title="interface in org.eclipse.wst.ws.service.policy">IFilter</A> filter)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>filter</CODE> - a filter a the service policies. This method may be null if + no filter is required. +<DT><B>Returns:</B><DD>returns all root level service policies. If a filter is specified + some service policies may be removed from the returned list. A root + level service policy is defined to be a service policy with no parent.</DL> +</DD> +</DL> +<HR> + +<A NAME="getServicePolicy(java.lang.String)"><!-- --></A><H3> +getServicePolicy</H3> +<PRE> +public <A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IServicePolicy.html" title="interface in org.eclipse.wst.ws.service.policy">IServicePolicy</A> <B>getServicePolicy</B>(java.lang.String id)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>id</CODE> - +<DT><B>Returns:</B><DD>returns a service policy given it's unique ID.</DL> +</DD> +</DL> +<HR> + +<A NAME="isProjectPreferencesEnabled(org.eclipse.core.resources.IProject)"><!-- --></A><H3> +isProjectPreferencesEnabled</H3> +<PRE> +public boolean <B>isProjectPreferencesEnabled</B>(org.eclipse.core.resources.IProject project)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>project</CODE> - +<DT><B>Returns:</B><DD>returns true if the specified project has been enabled for + project specific policy preferences.</DL> +</DD> +</DL> +<HR> + +<A NAME="setProjectPreferencesEnabled(org.eclipse.core.resources.IProject, boolean)"><!-- --></A><H3> +setProjectPreferencesEnabled</H3> +<PRE> +public void <B>setProjectPreferencesEnabled</B>(org.eclipse.core.resources.IProject project, + boolean value)</PRE> +<DL> +<DD>Sets whether project specific service policy preferences is enabled or not. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>project</CODE> - <DD><CODE>value</CODE> - </DL> +</DD> +</DL> +<HR> + +<A NAME="restoreDefaults()"><!-- --></A><H3> +restoreDefaults</H3> +<PRE> +public void <B>restoreDefaults</B>()</PRE> +<DL> +<DD>Restores the workspace level defaults. Note: the state changes made by + calling this method need to be committed or discarded by the platform. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="restoreDefaults(org.eclipse.core.resources.IProject)"><!-- --></A><H3> +restoreDefaults</H3> +<PRE> +public void <B>restoreDefaults</B>(org.eclipse.core.resources.IProject project)</PRE> +<DL> +<DD>Restores the project level defaults. Note: the state changes made by + calling this method need to be committed or discarded by the platform. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>project</CODE> - </DL> +</DD> +</DL> +<HR> + +<A NAME="createServicePolicy(org.eclipse.wst.ws.service.policy.IServicePolicy, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> +createServicePolicy</H3> +<PRE> +public <A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IServicePolicy.html" title="interface in org.eclipse.wst.ws.service.policy">IServicePolicy</A> <B>createServicePolicy</B>(<A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IServicePolicy.html" title="interface in org.eclipse.wst.ws.service.policy">IServicePolicy</A> parent, + java.lang.String id, + java.lang.String enumListId, + java.lang.String defaultEnumId)</PRE> +<DL> +<DD>This method creates an IServicePolicy object. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>parent</CODE> - the parent policy for this policy. If this policy has no + parent null may be specified.<DD><CODE>id</CODE> - This is a unique id for this service policy. If the id specified + is not unique trailing numerical digits in the id will be stripped off. + Numerical digits will then be added to end of the id to make it unique. + If the id is empty or null the framework will assign a unique id.<DD><CODE>enumListId</CODE> - If this policy's state is defined by an enumeration + the enumeration id should be specified here. Otherwise null should be + specified.<DD><CODE>defaultEnumId</CODE> - If this policy's state is defined by an enumeration + this parameter specifies the default value. This value may be null + if not using an enumeration or if the default value of the enumeration + should be used. +<DT><B>Returns:</B><DD>returns a service policy object.</DL> +</DD> +</DL> +<HR> + +<A NAME="removeServicePolicy(org.eclipse.wst.ws.service.policy.IServicePolicy)"><!-- --></A><H3> +removeServicePolicy</H3> +<PRE> +public void <B>removeServicePolicy</B>(<A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IServicePolicy.html" title="interface in org.eclipse.wst.ws.service.policy">IServicePolicy</A> policy)</PRE> +<DL> +<DD>Removes a service policy from the service policy platform. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>policy</CODE> - the service policy</DL> +</DD> +</DL> +<HR> + +<A NAME="addChildChangeListener(org.eclipse.wst.ws.service.policy.listeners.IPolicyChildChangeListener, boolean)"><!-- --></A><H3> +addChildChangeListener</H3> +<PRE> +public void <B>addChildChangeListener</B>(org.eclipse.wst.ws.service.policy.listeners.IPolicyChildChangeListener listener, + boolean onCommit)</PRE> +<DL> +<DD>This method allows calls to listener to any child change that is + made in the service policy platform regardless of where it is + located in the tree of service policies. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>listener</CODE> - <DD><CODE>onCommit</CODE> - indicates whether this listener should be invoked when + the the platform changes are committed.</DL> +</DD> +</DL> +<HR> + +<A NAME="queueChildChangeListeners(boolean)"><!-- --></A><H3> +queueChildChangeListeners</H3> +<PRE> +public void <B>queueChildChangeListeners</B>(boolean queue)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="removeChildChangeListener(org.eclipse.wst.ws.service.policy.listeners.IPolicyChildChangeListener, boolean)"><!-- --></A><H3> +removeChildChangeListener</H3> +<PRE> +public void <B>removeChildChangeListener</B>(org.eclipse.wst.ws.service.policy.listeners.IPolicyChildChangeListener listener, + boolean onCommit)</PRE> +<DL> +<DD>Removes a child change listener from the service policy platform. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>listener</CODE> - <DD><CODE>onCommit</CODE> - indicates whether this change listener should be removed + from the onCommit list.</DL> +</DD> +</DL> +<HR> + +<A NAME="addProjectLoadListener(org.eclipse.wst.ws.service.policy.listeners.IPolicyPlatformProjectLoadListener)"><!-- --></A><H3> +addProjectLoadListener</H3> +<PRE> +public void <B>addProjectLoadListener</B>(org.eclipse.wst.ws.service.policy.listeners.IPolicyPlatformProjectLoadListener listener)</PRE> +<DL> +<DD>Add a project platform listener. When a particular project is referenced + by in the service policy platform this listener will be called the first + time the project is loaded into the system. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener</DL> +</DD> +</DL> +<HR> + +<A NAME="removeProjectLoadListener(org.eclipse.wst.ws.service.policy.listeners.IPolicyPlatformProjectLoadListener)"><!-- --></A><H3> +removeProjectLoadListener</H3> +<PRE> +public void <B>removeProjectLoadListener</B>(org.eclipse.wst.ws.service.policy.listeners.IPolicyPlatformProjectLoadListener listener)</PRE> +<DL> +<DD>Removes a project platform listener. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener</DL> +</DD> +</DL> +<HR> + +<A NAME="getStateEnumeration(java.lang.String)"><!-- --></A><H3> +getStateEnumeration</H3> +<PRE> +public java.util.List<<A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IStateEnumerationItem.html" title="interface in org.eclipse.wst.ws.service.policy">IStateEnumerationItem</A>> <B>getStateEnumeration</B>(java.lang.String enumId)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>enumId</CODE> - +<DT><B>Returns:</B><DD>returns a list of state enumeration items given the unique + enumeration ID for this enumeration.</DL> +</DD> +</DL> +<HR> + +<A NAME="getStateItemEnumeration(java.lang.String)"><!-- --></A><H3> +getStateItemEnumeration</H3> +<PRE> +public <A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IStateEnumerationItem.html" title="interface in org.eclipse.wst.ws.service.policy">IStateEnumerationItem</A> <B>getStateItemEnumeration</B>(java.lang.String stateItemId)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>stateItemId</CODE> - +<DT><B>Returns:</B><DD>returns a state enumeration item given this ID for this enumeration + item.</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/ServicePolicyPlatform.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/ServicePolicyActivator.html" title="class in org.eclipse.wst.ws.service.policy"><B>PREV CLASS</B></A> + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../../index.html?org/eclipse/wst/ws/service/policy/ServicePolicyPlatform.html" target="_top"><B>FRAMES</B></A> + <A HREF="ServicePolicyPlatform.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML> |