LOVServiceLocal


1   /*
2    * Generated by XDoclet - Do not edit!
3    */
4   package org.bsf.listOfValues;
5   
6   /**
7    * Local interface for LOVService.
8    * @see LovBean
9    * @see LovValue
10   * @see LovBusinessInterface
11   */
12  public interface LOVServiceLocal
13     extends javax.ejb.EJBLocalObject  
14  {
15     /**
16      * Provides access to the metadata for a given list of values.
17      * @param p_lovOID The OID of the list of values for which we want the metadata.
18      * @return A list of LovMetaDataItems for the LOV corresponding to the given lovOID.
19      * @throws IllegalArgumentException if the given oid is null.
20      * @throws FinderException if a lov with the given oid isn't found.
21      * @see LovBean
22      * @see LovValue
23      * @see LovMetaDataItem
24      */
25     public java.util.List   getLOVMetaData( java.lang.Long   p_lovOID ) throws javax.ejb.FinderException  ;
26  
27     /**
28      * Returns the LovValue having the oid p_lovValueOID in the LOV whose oid is p_lovOID. If the LOV doesn't exist a NoSuchLovException is thrown whereas a NoSuchLovValueException is thrown if, while existing, the LOV does not contain the desired LovValue.
29      * @param p_lovOID The oid of the LOV that we want to parse.
30      * @param p_lovValueOID The oid that we want to find in the selected LOV.
31      * @return The LovValue having the oid p_lovValueOID in the LOV whose oid is p_lovOID.
32      * @throws NoSuchLovException if no LOV is found for the given p_lovOID.
33      * @throws NoSuchLovValueException if no LovValue is found having the p_lovValueOID in the selected LOV.
34      * @throws IllegalArgumentException if the given p_lovOID or p_lovValueOID is (are) null.
35      * @see LovValue
36      */
37     public org.bsf.listOfValues.lovValue.LovValue getLovValue( java.lang.Long   p_lovOID,java.lang.Long   p_lovValueOID ) throws org.bsf.listOfValues.exceptions.NoSuchLovException, org.bsf.listOfValues.exceptions.NoSuchLovValueException;
38  
39     /**
40      * Returns, in the order of the executed SQL, the list of LovValues corresponding to the given p_lovOID.
41      * @param p_lovOID The oid of the LOV that we want to retrieve.
42      * @return A list of LovValues corresponding to the execution of the given lovOID. The LovValues are returned as they are retrieve from the execution of the SQL statement (cf. ORDER BY clause).
43      * @throws IllegalArgumentException if the given lovOID is null.
44      * @throws NoSuchLovException if no LOV is having the given oid.
45      * @see LovBean
46      * @see LovValue
47      */
48     public java.util.List   getListOfValues( java.lang.Long   p_lovOID ) throws org.bsf.listOfValues.exceptions.NoSuchLovException;
49  
50     /**
51      * Returns a map (LovValueOID, LovValue) of LovValues corresponding to the given p_lovOID.
52      * @param p_lovOID The oid of the LOV that we want to retrieve.
53      * @return A list of LovValues corresponding to the execution of the given p_lovOID. The LovValues are returned as they are retrieve from the execution of the SQL statement (cf. ORDER BY clause).
54      * @throws IllegalArgumentException if the given p_lovOID is null.
55      * @throws NoSuchLovException if no LOV is having the given oid.
56      * @see LovBean
57      * @see LovValue
58      */
59     public java.util.Map   getLovValues( java.lang.Long   p_lovOID ) throws org.bsf.listOfValues.exceptions.NoSuchLovException;
60  
61     /**
62      * Ensures that the LOVs using the same TABLE_NAME as the LOV identified by the given OID are reloaded (in general due to a data update). It includes, of course, the lov identified by the given lovOID.
63      * @param p_lovOID The oid of the LOV whose TABLE_NAME will be used to refresh the LOVs.
64      * @throws IllegalArgumentException if the given p_lovOID is null.
65      * @throws NoSuchLovException if there is no LOV having the given lovOID.
66      * @see LovBean
67      * @see #resynchronizeListOfValues(String p_tableName)
68      */
69     public void resynchronizeListOfValues( java.lang.Long   p_lovOID ) throws org.bsf.listOfValues.exceptions.NoSuchLovException;
70  
71     /**
72      * Ensures that the LOVs referencing the TABLE_NAME are reseted. Usually because the underlying data have changed.
73      * @param p_tableName The oid of the LOV whose TABLE_NAME will be used to refresh the LOVs. Does nothing if the name is invalid (null, no match).
74      * @see LovBean
75      * @see #resynchronizeListOfValues(Long p_lovOID)
76      */
77     public void resynchronizeListOfValues( java.lang.String   p_tableName ) ;
78  
79  }
80
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags