LovValue


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.lovValue;
53  
54  import java.io.Serializable  ;
55  
56  /**
57   * Any Object that implements this interface can be handled as a LovValue. A
58   * LovValue contains Objects associated to field names (ie. properties).<p>
59   *
60   * Note that we call ListOfValues a List of LovValue (where those LovValue can
61   * be any Object implementing this interface).<p>
62   *
63   * A LovValue with three fields (Long, String, String) like (OID, SHORT_NAME, LONG_NAME)
64   * would look like:
65   *  (0,"None","Not defined") or (1,"FR","France") or (2,"UK","United Kingdom")
66   * whereas a ListOfValues for the COUNTRIES (in our example) would be the List
67   * of all those LovValue:
68   *  {(0,"None","Not defined"),(1,"FR","France"),(2,"UK","United Kingdom")}
69   *
70   * @see org.bsf.listOfValues.LovBean
71   * @see org.bsf.listOfValues.LovServiceBean
72   */
73  public interface LovValue extends Serializable   {
74      /**
75       * This method is deprecated since the 2.1 release. The PK of a LovValue is
76       * to be defined like any other field (but in first position, cf. LovBean)
77       * and can be of any type. Should still work with LovValues whose first field
78       * are a Long to ease the transition to the new way of handling the LovValue.
79       * Still, if defined in database, the LOV will have to be modified to include
80       * the definition of the first field. 
81       *
82       * @return the OID of the LovValue. For a given ListOfValue (a List of
83       * LovValues) a test on the OID should be enough to consider the LovValue
84       * as equal).
85       *
86       * @deprecated
87       */
88      public Long   getOid();
89  
90      /**
91       * @return the pk of the LovValue. For a given ListOfValue (a List of
92       * LovValues) a test on the pk should be enough to consider the LovValue
93       * as equal).  The first defined field is considered to be the PK.
94       */
95      public Object   getPK();
96  
97      /**
98       * This method enable the access to the values stored in this LovValue for
99       * the given field name.
100      *
101      * @param p_fieldName The field whose value is disired.
102      * @return The Object for the given field name in the LovValue, null if no
103      * matching field is found. The matching should be case insensitive.
104      */
105     public Object   getFieldValue( String   p_fieldName );
106 }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags