odk/examples/DevelopersGuide/OfficeDev/DesktopEnvironment/IOnewayLink.java

   1 /*************************************************************************
   2  *
   3  *  $RCSfile: IOnewayLink.java,v $
   4  *
   5  *  $Revision: 1.4 $
   6  *
   7  *  last change: $Author: rt $ $Date: 2005-01-31 16:38:16 $
   8  *
   9  *  The Contents of this file are made available subject to the terms of
  10  *  the BSD license.
  11  *
  12  *  Copyright (c) 2003 by Sun Microsystems, Inc.
  13  *  All rights reserved.
  14  *
  15  *  Redistribution and use in source and binary forms, with or without
  16  *  modification, are permitted provided that the following conditions
  17  *  are met:
  18  *  1. Redistributions of source code must retain the above copyright
  19  *     notice, this list of conditions and the following disclaimer.
  20  *  2. Redistributions in binary form must reproduce the above copyright
  21  *     notice, this list of conditions and the following disclaimer in the
  22  *     documentation and/or other materials provided with the distribution.
  23  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  24  *     contributors may be used to endorse or promote products derived
  25  *     from this software without specific prior written permission.
  26  *
  27  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  30  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  31  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  32  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  33  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  34  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  35  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  36  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  37  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38  *
  39  *************************************************************************/
  40
  41 import java.util.Vector;
  42
  43 // __________ Implementation __________
  44
  45 /**
  46  * We need a generic interface to forward any oneway uno interface method
  47  * by using threads to the original object. Reason:
  48  * It's not allowed to call synchronoues back to the office if a java object
  49  * was called in a oneway declared interface method. Then it must be
  50  * executed asynchronoues. To do so - a thread can be created which use this
  51  * interface. It get the object, which whis to be called back and the type and
  52  * parameter of the original request.
  53  *
  54  * @author     Andreas Schl&uuml;ns
  55  * @created    17.07.2002 08:09
  56  */
  57 public interface IOnewayLink
  58 {
  59     // _______________________________
  60
  61     /**
  62      * @param nRequest
  63      *          The two user of this callback can define an unique number,
  64      *          which identify the type of original interface method. So the called
  65      *          interface object can decide, which action will be neccessary.
  66      *
  67      * @param lParams
  68      *          If the original method used parameters, they will be coded here in
  69      *          a generic way. Only the called interface object know (it depends
  70      *          from the original request - see nRequest too), how this list must
  71      *          be interpreted.
  72      *          Note: Atomic types (e.g. int, long) will be transported as objects
  73      *          too (Integer, Long)!
  74      */
  75     public abstract void execOneway( int nRequest, Vector lParams );
  76 }