1 /*
2 * Copyright (c) 2002-2022, City of 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.securityheader;
35
36 import java.util.Collection;
37
38 /**
39 * ISecurityHeaderDAO Interface
40 */
41 public interface ISecurityHeaderDAO
42 {
43 /**
44 * Insert a new record in the table.
45 *
46 * @param securityheader
47 * instance of the SecurityHeader object to insert
48 */
49 void insert( SecurityHeader securityheader );
50
51 /**
52 * Update the record in the table.
53 *
54 * @param securityheader
55 * the reference of the SecurityHeader
56 */
57 void store( SecurityHeader securityheader );
58
59 /**
60 * Delete a record from the table.
61 *
62 * @param nSecurityHeaderId
63 * int identifier of the SecurityHeader to delete
64 */
65 void delete( int nSecurityHeaderId );
66
67 /**
68 * Update of the is_active column value of securityHeader which is specified in parameter.
69 *
70 * @param nSecurityHeaderId
71 * The securityHeader Id
72 * @param isActiveValue
73 * The value to set to is_active column
74 */
75 void updateIsActive( int nSecurityHeaderId, boolean isActiveValue );
76
77 // /////////////////////////////////////////////////////////////////////////
78 // Finders
79
80 /**
81 * load the data of the security header from the table
82 *
83 * @param nKey
84 * The identifier of the securityHeader
85 * @return The instance of the securityHeader
86 */
87 SecurityHeader load( int nKey );
88
89 /**
90 * Loads the data of all the security headers and returns them in form of a collection
91 *
92 * @return the collection which contains the data of all the security headers
93 */
94 Collection<SecurityHeader> selectAll( );
95
96 /**
97 * Returns all active security headers from a specified type (page or rest api)
98 *
99 * @param strType
100 * The type
101 * @return the collection which contains the data of all the securityHeaders
102 */
103 Collection<SecurityHeader> selectActiveByType( String strType );
104 }