LovBusinessInterface


1   /**
2    * Copyright (c) 2002 Bright Side Factory.  All rights reserved.
3    *
4    * Redistribution and use in source and binary forms, with or without
5    * modification, are permitted provided that the following conditions
6    * are met:
7    *
8    * 1. Redistributions of source code must retain the above copyright
9    *    notice, this list of conditions and the following disclaimer.
10   *
11   * 2. Redistributions in binary form must reproduce the above copyright
12   *    notice, this list of conditions and the following disclaimer in
13   *    the documentation and/or other materials provided with the
14   *    distribution.
15   *
16   * 3. The end-user documentation included with the redistribution,
17   *    if any, must include the following acknowledgment:
18   *       "This product includes software developed by the
19   *        Bright Side Factory (http://www.bs-factory.org/)."
20   *    Alternately, this acknowledgment may appear in the software itself,
21   *    if and wherever such third-party acknowledgments normally appear.
22   *
23   * 4. The names "Bright Side", "BS Factory" and "Bright Side Factory" must
24   *    not be used to endorse or promote products derived from this
25   *    software without prior written permission. For written
26   *    permission, please contact info@bs-factory.org.
27   *
28   * 5. Products derived from this software may not be called "Bright Side",
29   *    nor may "Bright Side" appear in their name, without prior written
30   *    permission of the Apache Software Foundation.
31   *
32   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
33   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
34   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
35   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
36   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
38   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
39   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
40   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
41   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
42   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43   * SUCH DAMAGE.
44   * ====================================================================
45   *
46   * This software consists of voluntary contributions made by many
47   * individuals on behalf of the Bright Side Factory.  For more
48   * information on the Bright Side Factory, please see
49   * <http://www.bs-factory.org/>.
50   */
51  
52  package org.bsf.listOfValues;
53  
54  import org.bsf.listOfValues.exceptions.NoSuchLovValueException;
55  import org.bsf.listOfValues.lovValue.LovValue;
56  
57  import java.rmi.RemoteException  ;
58  import java.util.HashMap  ;
59  import java.util.List  ;
60  
61  /**
62   * Defines the way that Objects holding the access to a List Of Values (LOV)
63   * should be accessed. Note that those LOV accessors (or providers) could be
64   * stateless Enterprise Java Beans as well as usual Java classes (generating
65   * the LOV on the fly for example).
66   *
67   * @see org.bsf.listOfValues.lovValue.LovValue
68   */
69  public interface LovBusinessInterface {
70      /**
71       * Returns the LovValue corresponding to the given OID in the List Of Values
72       * held in the implementing Object.
73       *
74       * @param p_lovValueOID The OID, in the List Of Values held in the implementing
75       * Object, of the LovValue desired.
76       * @return the LovValue corresponding to the given oid.
77       */
78      public LovValue getLovValue( Long   p_lovValueOID ) throws RemoteException  , NoSuchLovValueException;
79  
80      /**
81       * Gets the LOV mapped by OID.
82       *
83       * @return a HashMap of (key=OID, object=LovValue).
84       */
85      public HashMap   getLovValuesPerOID() throws RemoteException  ;
86  
87      /**
88       * Gets the LovValues in the order of their retrieval (for example if we
89       * retrieve them by using a EJB BMP and the LOV_REQUESTS table we will get
90       * them in the order of the result of the executed SQL).
91       *
92       * @return A List containing the LovValues.
93       */
94      public List   getListOfValues() throws RemoteException  ;
95  }
96
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags