1. /*

  2.  * Copyright 2002 Sun Microsystems, Inc. All rights reserved.

  3.  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

  4.  */

  5. 

  6. package javax.resource.cci;

  7. 

  8. import java.io.Serializable;

  9. 

  10. /** An InteractionSpec holds properties for driving an Interaction 

  11.  *  with an EIS instance. An InteractionSpec is used by an Interaction

  12.  *  to execute the specified function on an underlying EIS.

  13.  *

  14.  *  <p>The CCI specification defines a set of standard properties for

  15.  *  an InteractionSpec. An InteractionSpec implementation is not 

  16.  *  required to support a standard property if that property does 

  17.  *  not apply to its underlying EIS.

  18.  *

  19.  *  <p>The InteractionSpec implementation class must provide getter and

  20.  *  setter methods for each of its supported properties. The getter and 

  21.  *  setter methods convention should be based on the Java Beans design

  22.  *  pattern.

  23.  * 

  24.  *  <p>The standard properties are as follows:

  25.  *  <UL>

  26.  *     <LI>FunctionName: name of an EIS function

  27.  *     <LI>InteractionVerb: mode of interaction with an EIS instance:

  28.  *         SYNC_SEND, SYNC_SEND_RECEIVE, SYNC_RECEIVE

  29.  *     <LI>ExecutionTimeout: the number of milliseconds an Interaction 

  30.  *         will wait for an EIS to execute the specified function

  31.  *  </UL>

  32.  *  

  33.  *  <p>The following standard properties are used to give hints to an 

  34.  *  Interaction instance about the ResultSet requirements:

  35.  *  <UL>

  36.  *     <LI>FetchSize

  37.  *     <LI>FetchDirection

  38.  *     <LI>MaxFieldSize

  39.  *     <LI>ResultSetType

  40.  *     <LI>ResultSetConcurrency

  41.  *  </UL>

  42.  *

  43.  *  <p>A CCI implementation can provide additional properties beyond

  44.  *  that described in the InteractionSpec interface. Note that the 

  45.  *  format and type of the additional properties is specific to an EIS 

  46.  *  and is outside the scope of the CCI specification.

  47.  *  

  48.  *  <p>It is required that the InteractionSpec interface be implemented

  49.  *  as a JavaBean for the toolability support. The properties on the 

  50.  *  InteractionSpec implementation class should be defined through the 

  51.  *  getter and setter methods pattern. An implementation class for 

  52.  *  InteractionSpec interface is  required to implement the 

  53.  *  java.io.Serializable interface.

  54.  *

  55.  *  @author  Rahul Sharma

  56.  *  @version 0.8

  57.  *  @since   0.8

  58.  *  @see     javax.resource.cci.Interaction

  59. **/

  60. 

  61. public interface InteractionSpec extends java.io.Serializable {

  62.   

  63.   /**Interaction Verb type: The execution of an Interaction does only a 

  64.    * send to the target EIS instance. The input record is sent to the

  65.    * EIS instance without any synchronous response in terms of an 

  66.    * output Record or ResultSet.

  67.    */

  68.   public static final int SYNC_SEND = 0;

  69. 

  70.   /**Interaction Verb type: The execution of an Interaction sends a 

  71.    * request to the EIS instance and receives response synchronously. 

  72.    * The input record is sent to the EIS instance with the output 

  73.    * received either as Record or CCIResultSet.

  74.    **/

  75.   public static final int SYNC_SEND_RECEIVE = 1;

  76. 

  77.   /**The execution of an Interaction results in a synchronous 

  78.    * receive of an output Record. An example is: a session bean gets

  79.    * a method invocation and it uses this SEND_RECEIVE form of 

  80.    * interaction to retrieve messages that have been delivered to a 

  81.    * message queue. 

  82.    **/

  83.   public static final int SYNC_RECEIVE = 2;

  84. 

  85. }