| <!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_14) on Sun Aug 16 11:45:34 IDT 2009 --> | |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <TITLE> | |
| DynamicResource (Apache Wink 0.1-incubating API) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.wink.common.DynamicResource interface"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="DynamicResource (Apache Wink 0.1-incubating API)"; | |
| } | |
| </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"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DynamicResource.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-all.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/apache/wink/common/AbstractDynamicResource.html" title="class in org.apache.wink.common"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/wink/common/RestConstants.html" title="class in org.apache.wink.common"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/wink/common/DynamicResource.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="DynamicResource.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> | |
| <!-- ======== START OF CLASS DATA ======== --> | |
| <H2> | |
| <FONT SIZE="-1"> | |
| org.apache.wink.common</FONT> | |
| <BR> | |
| Interface DynamicResource</H2> | |
| <DL> | |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/wink/common/AbstractDynamicResource.html" title="class in org.apache.wink.common">AbstractDynamicResource</A></DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public interface <B>DynamicResource</B></DL> | |
| </PRE> | |
| <P> | |
| This interface replaces Path annotation to declare a resource. It's | |
| impossible to declare resource using both DynamicResource interface and Path | |
| annotation. | |
| <p> | |
| In general it's recommended to extend from AbstractDynamicResource, instead | |
| of implementing the DynamicResource. | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/wink/common/AbstractDynamicResource.html" title="class in org.apache.wink.common"><CODE>AbstractDynamicResource</CODE></A>, | |
| <CODE>Path</CODE></DL> | |
| <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/apache/wink/common/DynamicResource.html#getBeanName()">getBeanName</A></B>()</CODE> | |
| <BR> | |
| returns the name of the bean The bean name must be unique and usually | |
| should come from Spring.</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/apache/wink/common/DynamicResource.html#getCollectionTitle()">getCollectionTitle</A></B>()</CODE> | |
| <BR> | |
| Returns the collection title.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Object</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/wink/common/DynamicResource.html#getParent()">getParent</A></B>()</CODE> | |
| <BR> | |
| | |
| A parent of this resource, so the resulting path is a composition of the | |
| parent's path and this one.</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/apache/wink/common/DynamicResource.html#getPath()">getPath</A></B>()</CODE> | |
| <BR> | |
| Returns path.</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/apache/wink/common/DynamicResource.html#getWorkspaceTitle()">getWorkspaceTitle</A></B>()</CODE> | |
| <BR> | |
| Returns the workspace title.</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/apache/wink/common/DynamicResource.html#setBeanName(java.lang.String)">setBeanName</A></B>(java.lang.String beanName)</CODE> | |
| <BR> | |
| sets bean name.</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/apache/wink/common/DynamicResource.html#setParent(java.lang.Object)">setParent</A></B>(java.lang.Object parents)</CODE> | |
| <BR> | |
| | |
| Sets parents.</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="getBeanName()"><!-- --></A><H3> | |
| getBeanName</H3> | |
| <PRE> | |
| java.lang.String <B>getBeanName</B>()</PRE> | |
| <DL> | |
| <DD>returns the name of the bean The bean name must be unique and usually | |
| should come from Spring. If your bean is not generated by Spring, return | |
| null and the unique bean name will be generated. If method bean name was | |
| set using the setBeanName method, the method must return the same name | |
| that was set. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setBeanName(java.lang.String)"><!-- --></A><H3> | |
| setBeanName</H3> | |
| <PRE> | |
| void <B>setBeanName</B>(java.lang.String beanName)</PRE> | |
| <DL> | |
| <DD>sets bean name. After this method was invoked, the getBeanName() must | |
| return the same method that was set. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>beanName</CODE> - </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getPath()"><!-- --></A><H3> | |
| getPath</H3> | |
| <PRE> | |
| java.lang.String <B>getPath</B>()</PRE> | |
| <DL> | |
| <DD>Returns path. Similar to value() of javax.ws.rs.Path | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>path of the resource</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getParent()"><!-- --></A><H3> | |
| getParent</H3> | |
| <PRE> | |
| java.lang.Object <B>getParent</B>()</PRE> | |
| <DL> | |
| <DD><p> | |
| A parent of this resource, so the resulting path is a composition of the | |
| parent's path and this one. | |
| <p> | |
| Note that in comparison to the Parent annotation, the parent here must be | |
| reference to the resource and not class. | |
| <p> | |
| If method setParent was invoked, this method must return the same parent | |
| that was set. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>Resource instance of the parent dispatched URIs<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/wink/common/annotations/Parent.html" title="annotation in org.apache.wink.common.annotations"><CODE>Parent</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setParent(java.lang.Object)"><!-- --></A><H3> | |
| setParent</H3> | |
| <PRE> | |
| void <B>setParent</B>(java.lang.Object parents)</PRE> | |
| <DL> | |
| <DD><p> | |
| Sets parents. See getParent() for full description. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>parents</CODE> - </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getWorkspaceTitle()"><!-- --></A><H3> | |
| getWorkspaceTitle</H3> | |
| <PRE> | |
| java.lang.String <B>getWorkspaceTitle</B>()</PRE> | |
| <DL> | |
| <DD>Returns the workspace title. If the title was already defined using | |
| Workspace, the annotation data is overridden. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>workspace title<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/wink/common/annotations/Workspace.html" title="annotation in org.apache.wink.common.annotations"><CODE>Workspace</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getCollectionTitle()"><!-- --></A><H3> | |
| getCollectionTitle</H3> | |
| <PRE> | |
| java.lang.String <B>getCollectionTitle</B>()</PRE> | |
| <DL> | |
| <DD>Returns the collection title. If the title was already defined using | |
| Workspace, the annotation data is overridden. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>collection title<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/wink/common/annotations/Workspace.html" title="annotation in org.apache.wink.common.annotations"><CODE>Workspace</CODE></A></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"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DynamicResource.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-all.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/apache/wink/common/AbstractDynamicResource.html" title="class in org.apache.wink.common"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/wink/common/RestConstants.html" title="class in org.apache.wink.common"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/wink/common/DynamicResource.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="DynamicResource.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> | |
| Copyright © 2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. | |
| </BODY> | |
| </HTML> |