diff options
Diffstat (limited to 'site/trunk/site-publish/doc/javadoc/java-sca-1.6.1/sca-api/org/osoa/sca/ServiceReference.html')
| -rw-r--r-- | site/trunk/site-publish/doc/javadoc/java-sca-1.6.1/sca-api/org/osoa/sca/ServiceReference.html | 329 |
1 files changed, 329 insertions, 0 deletions
diff --git a/site/trunk/site-publish/doc/javadoc/java-sca-1.6.1/sca-api/org/osoa/sca/ServiceReference.html b/site/trunk/site-publish/doc/javadoc/java-sca-1.6.1/sca-api/org/osoa/sca/ServiceReference.html new file mode 100644 index 0000000000..2d1481534f --- /dev/null +++ b/site/trunk/site-publish/doc/javadoc/java-sca-1.6.1/sca-api/org/osoa/sca/ServiceReference.html @@ -0,0 +1,329 @@ +<!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_07) on Wed Oct 06 19:37:32 BST 2010 -->
+<TITLE>
+ServiceReference
+</TITLE>
+
+<META NAME="date" CONTENT="2010-10-06">
+
+<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="ServiceReference";
+ }
+}
+</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> </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="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/osoa/sca/RequestContext.html" title="interface in org.osoa.sca"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/osoa/sca/ServiceRuntimeException.html" title="class in org.osoa.sca"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/osoa/sca/ServiceReference.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="ServiceReference.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.osoa.sca</FONT>
+<BR>
+Interface ServiceReference<B></H2>
+<DL>
+<DT><DT><B>Type Parameters:</B><DD><CODE>B</CODE> - the Java interface associated with this reference</DL>
+<DL>
+<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../org/osoa/sca/CallableReference.html" title="interface in org.osoa.sca">CallableReference</A><B></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public interface <B>ServiceReference<B></B><DT>extends <A HREF="../../../org/osoa/sca/CallableReference.html" title="interface in org.osoa.sca">CallableReference</A><B></DL>
+</PRE>
+
+<P>
+A ServiceReference represents a client's perspective of a reference to another service.
+<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.Object</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/osoa/sca/ServiceReference.html#getCallback()">getCallback</A></B>()</CODE>
+
+<BR>
+ Returns the callback object.</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/osoa/sca/ServiceReference.html#getConversationID()">getConversationID</A></B>()</CODE>
+
+<BR>
+ Returns the id supplied by the user that will be associated with conversations initiated through this reference.</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/osoa/sca/ServiceReference.html#setCallback(java.lang.Object)">setCallback</A></B>(java.lang.Object callback)</CODE>
+
+<BR>
+ Sets the callback object.</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/osoa/sca/ServiceReference.html#setCallbackID(java.lang.Object)">setCallbackID</A></B>(java.lang.Object callbackID)</CODE>
+
+<BR>
+ Sets the callback ID.</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/osoa/sca/ServiceReference.html#setConversationID(java.lang.Object)">setConversationID</A></B>(java.lang.Object conversationId)</CODE>
+
+<BR>
+ Set the id to associate with any conversation started through this reference.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_org.osoa.sca.CallableReference"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from interface org.osoa.sca.<A HREF="../../../org/osoa/sca/CallableReference.html" title="interface in org.osoa.sca">CallableReference</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A HREF="../../../org/osoa/sca/CallableReference.html#getBusinessInterface()">getBusinessInterface</A>, <A HREF="../../../org/osoa/sca/CallableReference.html#getCallbackID()">getCallbackID</A>, <A HREF="../../../org/osoa/sca/CallableReference.html#getConversation()">getConversation</A>, <A HREF="../../../org/osoa/sca/CallableReference.html#getService()">getService</A>, <A HREF="../../../org/osoa/sca/CallableReference.html#isConversational()">isConversational</A></CODE></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="getConversationID()"><!-- --></A><H3>
+getConversationID</H3>
+<PRE>
+java.lang.Object <B>getConversationID</B>()</PRE>
+<DL>
+<DD>Returns the id supplied by the user that will be associated with conversations initiated through this reference.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the id to associated with any conversation initiated through this reference</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setConversationID(java.lang.Object)"><!-- --></A><H3>
+setConversationID</H3>
+<PRE>
+void <B>setConversationID</B>(java.lang.Object conversationId)
+ throws java.lang.IllegalStateException</PRE>
+<DL>
+<DD>Set the id to associate with any conversation started through this reference. + If the value supplied is null then the id will be generated by the implementation.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>conversationId</CODE> - the user-defined id to associated with a conversation
+<DT><B>Throws:</B>
+<DD><CODE>java.lang.IllegalStateException</CODE> - if a conversation is currently associated with this reference</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setCallbackID(java.lang.Object)"><!-- --></A><H3>
+setCallbackID</H3>
+<PRE>
+void <B>setCallbackID</B>(java.lang.Object callbackID)</PRE>
+<DL>
+<DD>Sets the callback ID.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>callbackID</CODE> - the callback ID</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getCallback()"><!-- --></A><H3>
+getCallback</H3>
+<PRE>
+java.lang.Object <B>getCallback</B>()</PRE>
+<DL>
+<DD>Returns the callback object.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the callback object</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setCallback(java.lang.Object)"><!-- --></A><H3>
+setCallback</H3>
+<PRE>
+void <B>setCallback</B>(java.lang.Object callback)</PRE>
+<DL>
+<DD>Sets the callback object.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>callback</CODE> - the callback object</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="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/osoa/sca/RequestContext.html" title="interface in org.osoa.sca"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/osoa/sca/ServiceRuntimeException.html" title="class in org.osoa.sca"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/osoa/sca/ServiceReference.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="ServiceReference.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>
|