| <!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:37 EDT 2008 --> |
| <TITLE> |
| IDescriptor |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.ws.service.policy.IDescriptor interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="IDescriptor"; |
| } |
| </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/IDescriptor.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"> |
| PREV CLASS |
| <A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IFilter.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/IDescriptor.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IDescriptor.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> |
| Interface IDescriptor</H2> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>IDescriptor</B></DL> |
| </PRE> |
| |
| <P> |
| This interface encapsulates the idea of a description for a service policy. |
| <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> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IDescriptor.html#getContextHelpId()">getContextHelpId</A></B>()</CODE> |
| |
| <BR> |
| Returns the context help id.</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/IDescriptor.html#getDescription()">getDescription</A></B>()</CODE> |
| |
| <BR> |
| Returns the description for this descriptor.</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/IDescriptor.html#getIconBundleId()">getIconBundleId</A></B>()</CODE> |
| |
| <BR> |
| Returns the icon bundle id.</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/IDescriptor.html#getIconPath()">getIconPath</A></B>()</CODE> |
| |
| <BR> |
| Returns the icon path relative to an icon bundle.</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/IDescriptor.html#getLongName()">getLongName</A></B>()</CODE> |
| |
| <BR> |
| Returns the long name for the descriptor.</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/IDescriptor.html#getShortName()">getShortName</A></B>()</CODE> |
| |
| <BR> |
| Returns the short name for the descriptor</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/IDescriptor.html#setContextHelpId(java.lang.String)">setContextHelpId</A></B>(java.lang.String contextHelpId)</CODE> |
| |
| <BR> |
| Sets the context help id for this descriptor.</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/IDescriptor.html#setDescription(java.lang.String)">setDescription</A></B>(java.lang.String description)</CODE> |
| |
| <BR> |
| Sets the description for this descriptor.</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/IDescriptor.html#setIconBundleId(java.lang.String)">setIconBundleId</A></B>(java.lang.String iconBundleId)</CODE> |
| |
| <BR> |
| Sets the icon bundle id for this descriptor.</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/IDescriptor.html#setIconPath(java.lang.String)">setIconPath</A></B>(java.lang.String iconPath)</CODE> |
| |
| <BR> |
| Sets the icon patch for this descriptor.</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/IDescriptor.html#setLongName(java.lang.String)">setLongName</A></B>(java.lang.String longName)</CODE> |
| |
| <BR> |
| Sets the long name for the descriptor.</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/IDescriptor.html#setShortName(java.lang.String)">setShortName</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Sets the short name for the descriptor.</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="getShortName()"><!-- --></A><H3> |
| getShortName</H3> |
| <PRE> |
| java.lang.String <B>getShortName</B>()</PRE> |
| <DL> |
| <DD>Returns the short name for the descriptor |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>returns the short name for the descriptor</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setShortName(java.lang.String)"><!-- --></A><H3> |
| setShortName</H3> |
| <PRE> |
| void <B>setShortName</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Sets the short name for the descriptor. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLongName()"><!-- --></A><H3> |
| getLongName</H3> |
| <PRE> |
| java.lang.String <B>getLongName</B>()</PRE> |
| <DL> |
| <DD>Returns the long name for the descriptor. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>returns the long name for the descriptor.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLongName(java.lang.String)"><!-- --></A><H3> |
| setLongName</H3> |
| <PRE> |
| void <B>setLongName</B>(java.lang.String longName)</PRE> |
| <DL> |
| <DD>Sets the long name for the descriptor. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>longName</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDescription()"><!-- --></A><H3> |
| getDescription</H3> |
| <PRE> |
| java.lang.String <B>getDescription</B>()</PRE> |
| <DL> |
| <DD>Returns the description for this descriptor. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>returns the description for this descriptor.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDescription(java.lang.String)"><!-- --></A><H3> |
| setDescription</H3> |
| <PRE> |
| void <B>setDescription</B>(java.lang.String description)</PRE> |
| <DL> |
| <DD>Sets the description for this descriptor. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>description</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getIconPath()"><!-- --></A><H3> |
| getIconPath</H3> |
| <PRE> |
| java.lang.String <B>getIconPath</B>()</PRE> |
| <DL> |
| <DD>Returns the icon path relative to an icon bundle. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>returns the icon path for this descriptor. This path |
| is relative to the plugin specified by the icon bundle id. This |
| method may return null if there is no icon for this descriptor.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setIconPath(java.lang.String)"><!-- --></A><H3> |
| setIconPath</H3> |
| <PRE> |
| void <B>setIconPath</B>(java.lang.String iconPath)</PRE> |
| <DL> |
| <DD>Sets the icon patch for this descriptor. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>iconPath</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getIconBundleId()"><!-- --></A><H3> |
| getIconBundleId</H3> |
| <PRE> |
| java.lang.String <B>getIconBundleId</B>()</PRE> |
| <DL> |
| <DD>Returns the icon bundle id. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>returns the bundle ID of a plugin that contains an icon. This |
| method may return null if there is no icon associated with this descriptor.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setIconBundleId(java.lang.String)"><!-- --></A><H3> |
| setIconBundleId</H3> |
| <PRE> |
| void <B>setIconBundleId</B>(java.lang.String iconBundleId)</PRE> |
| <DL> |
| <DD>Sets the icon bundle id for this descriptor. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>iconBundleId</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getContextHelpId()"><!-- --></A><H3> |
| getContextHelpId</H3> |
| <PRE> |
| java.lang.String <B>getContextHelpId</B>()</PRE> |
| <DL> |
| <DD>Returns the context help id. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>returns the context help id for this descriptor. This method |
| may return null if no context has been specified.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setContextHelpId(java.lang.String)"><!-- --></A><H3> |
| setContextHelpId</H3> |
| <PRE> |
| void <B>setContextHelpId</B>(java.lang.String contextHelpId)</PRE> |
| <DL> |
| <DD>Sets the context help id for this descriptor. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>contextHelpId</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/IDescriptor.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"> |
| PREV CLASS |
| <A HREF="../../../../../../org/eclipse/wst/ws/service/policy/IFilter.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/IDescriptor.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IDescriptor.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> |
