PageRenderTime 53ms CodeModel.GetById 20ms RepoModel.GetById 1ms app.codeStats 0ms

/lib/docs/org/apache/xmlrpc/XmlRpcRequest.html

http://mp-rechnungs-und-kundenverwaltung.googlecode.com/
HTML | 289 lines | 234 code | 35 blank | 20 comment | 0 complexity | 2ef407adae2d180ce6263e10e70abdef MD5 | raw file
Possible License(s): LGPL-3.0, Apache-2.0, GPL-3.0, GPL-2.0, AGPL-3.0, JSON, BSD-3-Clause
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc (build 1.6.0_0) on Mon Apr 20 21:45:55 CEST 2009 -->
  6. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <TITLE>
  8. XmlRpcRequest (Apache XML-RPC 3.1.2 API)
  9. </TITLE>
  10. <META NAME="date" CONTENT="2009-04-20">
  11. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
  12. <SCRIPT type="text/javascript">
  13. function windowTitle()
  14. {
  15. if (location.href.indexOf('is-external=true') == -1) {
  16. parent.document.title="XmlRpcRequest (Apache XML-RPC 3.1.2 API)";
  17. }
  18. }
  19. </SCRIPT>
  20. <NOSCRIPT>
  21. </NOSCRIPT>
  22. </HEAD>
  23. <BODY BGCOLOR="white" onload="windowTitle();">
  24. <HR>
  25. <!-- ========= START OF TOP NAVBAR ======= -->
  26. <A NAME="navbar_top"><!-- --></A>
  27. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  28. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  29. <TR>
  30. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  31. <A NAME="navbar_top_firstrow"><!-- --></A>
  32. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  33. <TR ALIGN="center" VALIGN="top">
  34. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  35. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  36. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  37. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcRequest.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  38. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  39. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  40. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  41. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  42. </TR>
  43. </TABLE>
  44. </TD>
  45. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  46. </EM>
  47. </TD>
  48. </TR>
  49. <TR>
  50. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  51. &nbsp;<A HREF="../../../org/apache/xmlrpc/XmlRpcHandler.html" title="interface in org.apache.xmlrpc"><B>PREV CLASS</B></A>&nbsp;
  52. &nbsp;<A HREF="../../../org/apache/xmlrpc/XmlRpcRequestConfig.html" title="interface in org.apache.xmlrpc"><B>NEXT CLASS</B></A></FONT></TD>
  53. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  54. <A HREF="../../../index.html?org/apache/xmlrpc/XmlRpcRequest.html" target="_top"><B>FRAMES</B></A> &nbsp;
  55. &nbsp;<A HREF="XmlRpcRequest.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  56. &nbsp;<SCRIPT type="text/javascript">
  57. <!--
  58. if(window==top) {
  59. document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  60. }
  61. //-->
  62. </SCRIPT>
  63. <NOSCRIPT>
  64. <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  65. </NOSCRIPT>
  66. </FONT></TD>
  67. </TR>
  68. <TR>
  69. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  70. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  71. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  72. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  73. </TR>
  74. </TABLE>
  75. <A NAME="skip-navbar_top"></A>
  76. <!-- ========= END OF TOP NAVBAR ========= -->
  77. <HR>
  78. <!-- ======== START OF CLASS DATA ======== -->
  79. <H2>
  80. <FONT SIZE="-1">
  81. org.apache.xmlrpc</FONT>
  82. <BR>
  83. Interface XmlRpcRequest</H2>
  84. <DL>
  85. <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/apache/xmlrpc/client/XmlRpcClientRequestImpl.html" title="class in org.apache.xmlrpc.client">XmlRpcClientRequestImpl</A></DD>
  86. </DL>
  87. <HR>
  88. <DL>
  89. <DT><PRE>public interface <B>XmlRpcRequest</B></DL>
  90. </PRE>
  91. <P>
  92. Interface to an XML-RPC request made by a client. Replaces the
  93. class <code>org.apache.xmlrpc.XmlRpcClientRequest</code> from
  94. Apache XML-RPC 2.0.
  95. <P>
  96. <P>
  97. <DL>
  98. <DT><B>Since:</B></DT>
  99. <DD>3.0</DD>
  100. </DL>
  101. <HR>
  102. <P>
  103. <!-- ========== METHOD SUMMARY =========== -->
  104. <A NAME="method_summary"><!-- --></A>
  105. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  106. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  107. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  108. <B>Method Summary</B></FONT></TH>
  109. </TR>
  110. <TR BGCOLOR="white" CLASS="TableRowColor">
  111. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  112. <CODE>&nbsp;<A HREF="../../../org/apache/xmlrpc/XmlRpcRequestConfig.html" title="interface in org.apache.xmlrpc">XmlRpcRequestConfig</A></CODE></FONT></TD>
  113. <TD><CODE><B><A HREF="../../../org/apache/xmlrpc/XmlRpcRequest.html#getConfig()">getConfig</A></B>()</CODE>
  114. <BR>
  115. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the request configuration.</TD>
  116. </TR>
  117. <TR BGCOLOR="white" CLASS="TableRowColor">
  118. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  119. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
  120. <TD><CODE><B><A HREF="../../../org/apache/xmlrpc/XmlRpcRequest.html#getMethodName()">getMethodName</A></B>()</CODE>
  121. <BR>
  122. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the requests method name.</TD>
  123. </TR>
  124. <TR BGCOLOR="white" CLASS="TableRowColor">
  125. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  126. <CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
  127. <TD><CODE><B><A HREF="../../../org/apache/xmlrpc/XmlRpcRequest.html#getParameter(int)">getParameter</A></B>(int&nbsp;pIndex)</CODE>
  128. <BR>
  129. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the parameter with index <code>pIndex</code>.</TD>
  130. </TR>
  131. <TR BGCOLOR="white" CLASS="TableRowColor">
  132. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  133. <CODE>&nbsp;int</CODE></FONT></TD>
  134. <TD><CODE><B><A HREF="../../../org/apache/xmlrpc/XmlRpcRequest.html#getParameterCount()">getParameterCount</A></B>()</CODE>
  135. <BR>
  136. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of parameters.</TD>
  137. </TR>
  138. </TABLE>
  139. &nbsp;
  140. <P>
  141. <!-- ============ METHOD DETAIL ========== -->
  142. <A NAME="method_detail"><!-- --></A>
  143. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  144. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  145. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  146. <B>Method Detail</B></FONT></TH>
  147. </TR>
  148. </TABLE>
  149. <A NAME="getConfig()"><!-- --></A><H3>
  150. getConfig</H3>
  151. <PRE>
  152. <A HREF="../../../org/apache/xmlrpc/XmlRpcRequestConfig.html" title="interface in org.apache.xmlrpc">XmlRpcRequestConfig</A> <B>getConfig</B>()</PRE>
  153. <DL>
  154. <DD>Returns the request configuration.
  155. <P>
  156. <DD><DL>
  157. <DT><B>Returns:</B><DD>The request configuration.</DL>
  158. </DD>
  159. </DL>
  160. <HR>
  161. <A NAME="getMethodName()"><!-- --></A><H3>
  162. getMethodName</H3>
  163. <PRE>
  164. java.lang.String <B>getMethodName</B>()</PRE>
  165. <DL>
  166. <DD>Returns the requests method name.
  167. <P>
  168. <DD><DL>
  169. <DT><B>Returns:</B><DD>Name of the method being invoked.</DL>
  170. </DD>
  171. </DL>
  172. <HR>
  173. <A NAME="getParameterCount()"><!-- --></A><H3>
  174. getParameterCount</H3>
  175. <PRE>
  176. int <B>getParameterCount</B>()</PRE>
  177. <DL>
  178. <DD>Returns the number of parameters.
  179. <P>
  180. <DD><DL>
  181. <DT><B>Returns:</B><DD>Number of parameters.</DL>
  182. </DD>
  183. </DL>
  184. <HR>
  185. <A NAME="getParameter(int)"><!-- --></A><H3>
  186. getParameter</H3>
  187. <PRE>
  188. java.lang.Object <B>getParameter</B>(int&nbsp;pIndex)</PRE>
  189. <DL>
  190. <DD>Returns the parameter with index <code>pIndex</code>.
  191. <P>
  192. <DD><DL>
  193. <DT><B>Parameters:</B><DD><CODE>pIndex</CODE> - Number between 0 and <A HREF="../../../org/apache/xmlrpc/XmlRpcRequest.html#getParameterCount()"><CODE>getParameterCount()</CODE></A>-1.
  194. <DT><B>Returns:</B><DD>Parameter being sent to the server.</DL>
  195. </DD>
  196. </DL>
  197. <!-- ========= END OF CLASS DATA ========= -->
  198. <HR>
  199. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  200. <A NAME="navbar_bottom"><!-- --></A>
  201. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  202. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  203. <TR>
  204. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  205. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  206. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  207. <TR ALIGN="center" VALIGN="top">
  208. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  209. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  210. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  211. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcRequest.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  212. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  213. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  214. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  215. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  216. </TR>
  217. </TABLE>
  218. </TD>
  219. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  220. </EM>
  221. </TD>
  222. </TR>
  223. <TR>
  224. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  225. &nbsp;<A HREF="../../../org/apache/xmlrpc/XmlRpcHandler.html" title="interface in org.apache.xmlrpc"><B>PREV CLASS</B></A>&nbsp;
  226. &nbsp;<A HREF="../../../org/apache/xmlrpc/XmlRpcRequestConfig.html" title="interface in org.apache.xmlrpc"><B>NEXT CLASS</B></A></FONT></TD>
  227. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  228. <A HREF="../../../index.html?org/apache/xmlrpc/XmlRpcRequest.html" target="_top"><B>FRAMES</B></A> &nbsp;
  229. &nbsp;<A HREF="XmlRpcRequest.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  230. &nbsp;<SCRIPT type="text/javascript">
  231. <!--
  232. if(window==top) {
  233. document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  234. }
  235. //-->
  236. </SCRIPT>
  237. <NOSCRIPT>
  238. <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  239. </NOSCRIPT>
  240. </FONT></TD>
  241. </TR>
  242. <TR>
  243. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  244. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  245. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  246. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  247. </TR>
  248. </TABLE>
  249. <A NAME="skip-navbar_bottom"></A>
  250. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  251. <HR>
  252. Copyright &#169; 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
  253. </BODY>
  254. </HTML>