View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.portal.business.right;
35  
36  import java.util.Collection;
37  
38  
39  /**
40   * RightDAO Interface
41   */
42  public interface IRightDAO
43  {
44      /**
45       * Delete a record from the table
46       *
47       * @param strIdRight string identifier of the admin right to delete
48       */
49      void delete( String strIdRight );
50  
51      /**
52       * Insert a new record in the table.
53       *
54       * @param right instance of the right to insert
55       */
56      void insert( Right right );
57  
58      /**
59       * load the data of the right from the table
60       *
61       * @param strId The identifier of the admin right
62       * @return The instance of the admin right
63       */
64      Right load( String strId );
65  
66      /**
67       * Loads the data of all the rights and returns them in form of a collection
68       *
69       * @return the collection which contains the data of all the rights
70       */
71      Collection<Right> selectRightsList(  );
72  
73      /**
74       * Update the record in the table
75       *
76       * @param right the reference of the admin right
77       */
78      void store( Right right );
79  
80      /**
81       * Loads the data of all the rights with level greater or equal than nLevel
82       * and returns them in form of a collection
83       *
84       * @param nLevel The right's level
85       * @return the collection which contains the data of all the rights
86       */
87      Collection<Right> selectRightsList( int nLevel );
88  
89      /**
90       * Loads the data of all the rights with the specified feature group
91       * and returns them in form of a collection
92       *
93       * @param strFeatureGroup the name of the feature group
94       * @return the collection which contains the data of all the rights
95       */
96      Collection<Right> selectRightsList( String strFeatureGroup );
97  }