blob: dd4028850031fb932a04a6bcab3abcf344d81695 [file] [log] [blame]
<!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:39 EDT 2008 -->
<TITLE>
ServicePolicyPlatformUI
</TITLE>
<META NAME="keywords" CONTENT="org.eclipse.wst.ws.service.policy.ui.ServicePolicyPlatformUI class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="ServicePolicyPlatformUI";
}
</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ServicePolicyPlatformUI.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/ServicePolicyActivatorUI.html" title="class in org.eclipse.wst.ws.service.policy.ui"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../index.html?org/eclipse/wst/ws/service/policy/ui/ServicePolicyPlatformUI.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ServicePolicyPlatformUI.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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.ui</FONT>
<BR>
Class ServicePolicyPlatformUI</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.ws.service.policy.ui.ServicePolicyPlatformUI</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>ServicePolicyPlatformUI</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
This class is used to get Service policy UI information.
<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>&nbsp;java.util.List&lt;<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/IPolicyOperation.html" title="interface in org.eclipse.wst.ws.service.policy.ui">IPolicyOperation</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/ServicePolicyPlatformUI.html#getAllOperations()">getAllOperations</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns all the operations for all known policies.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/ServicePolicyPlatformUI.html" title="class in org.eclipse.wst.ws.service.policy.ui">ServicePolicyPlatformUI</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/ServicePolicyPlatformUI.html#getInstance()">getInstance</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an instance of this service policy platform UI object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/IPolicyOperation.html" title="interface in org.eclipse.wst.ws.service.policy.ui">IPolicyOperation</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/ServicePolicyPlatformUI.html#getOperation(org.eclipse.wst.ws.service.policy.IServicePolicy, java.lang.String)">getOperation</A></B>(<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/IServicePolicy.html" title="interface in org.eclipse.wst.ws.service.policy">IServicePolicy</A>&nbsp;policy,
java.lang.String&nbsp;id)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an operation that is associated with a particular service policy
and has the specified id.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.List&lt;<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/IPolicyOperation.html" title="interface in org.eclipse.wst.ws.service.policy.ui">IPolicyOperation</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/ServicePolicyPlatformUI.html#getOperations(org.eclipse.wst.ws.service.policy.IServicePolicy, boolean)">getOperations</A></B>(<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/IServicePolicy.html" title="interface in org.eclipse.wst.ws.service.policy">IServicePolicy</A>&nbsp;policy,
boolean&nbsp;isWorkspace)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the list of operations for this policy.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.List&lt;java.util.List&lt;<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/IPolicyOperation.html" title="interface in org.eclipse.wst.ws.service.policy.ui">IPolicyOperation</A>&gt;&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/ServicePolicyPlatformUI.html#getOperationsList(java.util.List, boolean)">getOperationsList</A></B>(java.util.List&lt;<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/IServicePolicy.html" title="interface in org.eclipse.wst.ws.service.policy">IServicePolicy</A>&gt;&nbsp;policies,
boolean&nbsp;isWorkspace)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of list policy operations which are associated with
the specified service policies.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.List&lt;<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/IQuickFixActionInfo.html" title="interface in org.eclipse.wst.ws.service.policy.ui">IQuickFixActionInfo</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/ServicePolicyPlatformUI.html#getQuickFixes(org.eclipse.core.runtime.IStatus)">getQuickFixes</A></B>(org.eclipse.core.runtime.IStatus&nbsp;status)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of quick fix info for the specified status object.</TD>
</TR>
</TABLE>
&nbsp;<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>
&nbsp;
<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/ui/ServicePolicyPlatformUI.html" title="class in org.eclipse.wst.ws.service.policy.ui">ServicePolicyPlatformUI</A> <B>getInstance</B>()</PRE>
<DL>
<DD>Returns an instance of this service policy platform UI object.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>returns an instance of this service policy platform UI object.</DL>
</DD>
</DL>
<HR>
<A NAME="getAllOperations()"><!-- --></A><H3>
getAllOperations</H3>
<PRE>
public java.util.List&lt;<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/IPolicyOperation.html" title="interface in org.eclipse.wst.ws.service.policy.ui">IPolicyOperation</A>&gt; <B>getAllOperations</B>()</PRE>
<DL>
<DD>Returns all the operations for all known policies.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>returns all the operations for all known policies.</DL>
</DD>
</DL>
<HR>
<A NAME="getOperation(org.eclipse.wst.ws.service.policy.IServicePolicy, java.lang.String)"><!-- --></A><H3>
getOperation</H3>
<PRE>
public <A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/IPolicyOperation.html" title="interface in org.eclipse.wst.ws.service.policy.ui">IPolicyOperation</A> <B>getOperation</B>(<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/IServicePolicy.html" title="interface in org.eclipse.wst.ws.service.policy">IServicePolicy</A>&nbsp;policy,
java.lang.String&nbsp;id)</PRE>
<DL>
<DD>Returns an operation that is associated with a particular service policy
and has the specified id.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>policy</CODE> - the service policy<DD><CODE>id</CODE> - the operation id.
<DT><B>Returns:</B><DD>returns the operation being searched for or null is not found.</DL>
</DD>
</DL>
<HR>
<A NAME="getOperations(org.eclipse.wst.ws.service.policy.IServicePolicy, boolean)"><!-- --></A><H3>
getOperations</H3>
<PRE>
public java.util.List&lt;<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/IPolicyOperation.html" title="interface in org.eclipse.wst.ws.service.policy.ui">IPolicyOperation</A>&gt; <B>getOperations</B>(<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/IServicePolicy.html" title="interface in org.eclipse.wst.ws.service.policy">IServicePolicy</A>&nbsp;policy,
boolean&nbsp;isWorkspace)</PRE>
<DL>
<DD>Returns the list of operations for this policy.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>policy</CODE> - the policy<DD><CODE>isWorkspace</CODE> - true if this is a preference page context
<DT><B>Returns:</B><DD>returns the list of operations for this policy.</DL>
</DD>
</DL>
<HR>
<A NAME="getOperationsList(java.util.List, boolean)"><!-- --></A><H3>
getOperationsList</H3>
<PRE>
public java.util.List&lt;java.util.List&lt;<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/IPolicyOperation.html" title="interface in org.eclipse.wst.ws.service.policy.ui">IPolicyOperation</A>&gt;&gt; <B>getOperationsList</B>(java.util.List&lt;<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/IServicePolicy.html" title="interface in org.eclipse.wst.ws.service.policy">IServicePolicy</A>&gt;&nbsp;policies,
boolean&nbsp;isWorkspace)</PRE>
<DL>
<DD>Returns a list of list policy operations which are associated with
the specified service policies.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>policies</CODE> - <DD><CODE>isWorkspace</CODE> -
<DT><B>Returns:</B><DD>returns a list that contains a list of operations. Each list
as the top level contains list of IPolicyOperations that reference the
same base operation. However, they will each have different associated
policies.</DL>
</DD>
</DL>
<HR>
<A NAME="getQuickFixes(org.eclipse.core.runtime.IStatus)"><!-- --></A><H3>
getQuickFixes</H3>
<PRE>
public java.util.List&lt;<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/IQuickFixActionInfo.html" title="interface in org.eclipse.wst.ws.service.policy.ui">IQuickFixActionInfo</A>&gt; <B>getQuickFixes</B>(org.eclipse.core.runtime.IStatus&nbsp;status)</PRE>
<DL>
<DD>Returns a list of quick fix info for the specified status object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>status</CODE> -
<DT><B>Returns:</B><DD>returns a list of quick fixes for this status object. If
no quick fixes are available an empty list will be returned.</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ServicePolicyPlatformUI.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../../org/eclipse/wst/ws/service/policy/ui/ServicePolicyActivatorUI.html" title="class in org.eclipse.wst.ws.service.policy.ui"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../index.html?org/eclipse/wst/ws/service/policy/ui/ServicePolicyPlatformUI.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ServicePolicyPlatformUI.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>