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

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