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.rbac;
35  
36  import java.util.Collection;
37  
38  
39  /**
40   * AdminRoleDAO Interface
41   */
42  public interface IAdminRoleDAO
43  {
44      /**
45       * Check that the given key points to an existing role
46       *
47       * @param strRoleKey The role key
48       * @return true if the role exists, false otherwise
49       */
50      boolean checkExistRole( String strRoleKey );
51  
52      /**
53       * Delete a record from the table
54       *
55       * @param strRoleKey The AdminRole object
56       */
57      void delete( String strRoleKey );
58  
59      /**
60       * Insert a new record in the table.
61       *
62       * @param role The role object
63       */
64      void insert( AdminRole role );
65  
66      /**
67       * Load the data of AdminRole from the table
68       *
69       * @param strRoleKey The identifier of AdminRole
70       * @return the instance of the AdminRole
71       */
72      AdminRole load( String strRoleKey );
73  
74      /**
75       * Load the list of roles
76       *
77       * @return The Collection of the Roles
78       */
79      Collection<AdminRole> selectRoleList(  );
80  
81      /**
82       * Update the record identified by the given role key with the given role in the table
83       *
84       * @param strRoleKey the key of the role to modify
85       * @param role The reference of role to be the new one
86       */
87      void store( String strRoleKey, AdminRole role );
88  }