Google Git
Sign in
eclipse / gerrit / jsf / webtools.jsf.docs / 1ae5a9adf9583b386ce5c6efb7d814a11f398b24 / . / plugins / org.eclipse.jst.jsf.doc.dev / html / api_reference / org / eclipse / jst / jsf / core / jsfappconfig / IJSFAppConfigProvider.html
blob: 5acc368db9bf7643bead3178fea6566fe4b1bfcf [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.6.0_06) on Fri Jun 05 14:31:19 PDT 2009 -->
<TITLE>
IJSFAppConfigProvider
</TITLE>
<META NAME="date" CONTENT="2009-06-05">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IJSFAppConfigProvider";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= 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;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IJSFAppConfigProvider.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/jst/jsf/core/jsfappconfig/IJSFAppConfigLocater.html" title="interface in org.eclipse.jst.jsf.core.jsfappconfig"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigProvidersChangeListener.html" title="interface in org.eclipse.jst.jsf.core.jsfappconfig"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigProvider.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IJSFAppConfigProvider.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>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.eclipse.jst.jsf.core.jsfappconfig</FONT>
<BR>
Interface IJSFAppConfigProvider</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/AbstractJSFAppConfigProvider.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">AbstractJSFAppConfigProvider</A>, <A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/ArtifactEditJSFAppConfigProvider.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">ArtifactEditJSFAppConfigProvider</A>, <A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/ImplicitRuntimeJSFAppConfigProvider.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">ImplicitRuntimeJSFAppConfigProvider</A>, <A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/JARFileJSFAppConfigProvider.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">JARFileJSFAppConfigProvider</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IJSFAppConfigProvider</B></DL>
</PRE>
<P>
IJSFAppConfigProvider is the interface that Objects capable of providing
JSF application configuration models must implement.
<p><b>Provisional API - subject to change</b></p>
<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;<A HREF="../../../../../../org/eclipse/jst/jsf/facesconfig/emf/FacesConfigType.html" title="interface in org.eclipse.jst.jsf.facesconfig.emf">FacesConfigType</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigProvider.html#getFacesConfigModel()">getFacesConfigModel</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the root element of the application configuration model for read
access.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigProvider.html#releaseFacesConfigModel()">releaseFacesConfigModel</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Releases resources associated with acquiring the application
configuration model (if any).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigProvider.html#setJSFAppConfigLocater(org.eclipse.jst.jsf.core.jsfappconfig.IJSFAppConfigLocater)">setJSFAppConfigLocater</A></B>(<A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigLocater.html" title="interface in org.eclipse.jst.jsf.core.jsfappconfig">IJSFAppConfigLocater</A>&nbsp;locater)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the <A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigLocater.html" title="interface in org.eclipse.jst.jsf.core.jsfappconfig"><CODE>IJSFAppConfigLocater</CODE></A> instance that located this
instance.</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="setJSFAppConfigLocater(org.eclipse.jst.jsf.core.jsfappconfig.IJSFAppConfigLocater)"><!-- --></A><H3>
setJSFAppConfigLocater</H3>
<PRE>
void <B>setJSFAppConfigLocater</B>(<A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigLocater.html" title="interface in org.eclipse.jst.jsf.core.jsfappconfig">IJSFAppConfigLocater</A>&nbsp;locater)</PRE>
<DL>
<DD>Sets the <A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigLocater.html" title="interface in org.eclipse.jst.jsf.core.jsfappconfig"><CODE>IJSFAppConfigLocater</CODE></A> instance that located this
instance.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locater</CODE> - <A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigLocater.html" title="interface in org.eclipse.jst.jsf.core.jsfappconfig"><CODE>IJSFAppConfigLocater</CODE></A> instance that located this
instance.</DL>
</DD>
</DL>
<HR>
<A NAME="getFacesConfigModel()"><!-- --></A><H3>
getFacesConfigModel</H3>
<PRE>
<A HREF="../../../../../../org/eclipse/jst/jsf/facesconfig/emf/FacesConfigType.html" title="interface in org.eclipse.jst.jsf.facesconfig.emf">FacesConfigType</A> <B>getFacesConfigModel</B>()</PRE>
<DL>
<DD>Gets the root element of the application configuration model for read
access.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>FacesConfigType instance, which is the root element of an
application configuration model.</DL>
</DD>
</DL>
<HR>
<A NAME="releaseFacesConfigModel()"><!-- --></A><H3>
releaseFacesConfigModel</H3>
<PRE>
void <B>releaseFacesConfigModel</B>()</PRE>
<DL>
<DD>Releases resources associated with acquiring the application
configuration model (if any).
<P>
<DD><DL>
</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;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IJSFAppConfigProvider.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/jst/jsf/core/jsfappconfig/IJSFAppConfigLocater.html" title="interface in org.eclipse.jst.jsf.core.jsfappconfig"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigProvidersChangeListener.html" title="interface in org.eclipse.jst.jsf.core.jsfappconfig"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigProvider.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IJSFAppConfigProvider.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>