1 /*
2 * Copyright (c) 2002-2023, 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.plugins.document.business.attributes;
35
36 import fr.paris.lutece.plugins.document.business.DocumentType;
37
38 import java.util.Collection;
39 import java.util.List;
40
41 /**
42 * DocumentAttribute Interface
43 */
44 public interface IDocumentAttributeDAO
45 {
46 /**
47 * Delete a record from the table
48 *
49 * @param nAttributeId
50 * The DocumentAttribute Id
51 */
52 void delete( int nAttributeId );
53
54 /**
55 * Returns the parameter values of an attribute
56 *
57 * @param nAttributeId
58 * The attribute Id
59 * @param strParameterName
60 * The parameter name
61 * @return The parameter values of an attribute
62 */
63 List<String> getAttributeParameterValues( int nAttributeId, String strParameterName );
64
65 /**
66 * Insert a new record in the table.
67 *
68 *
69 * @param documentAttribute
70 * The documentAttribute object
71 */
72 void insert( DocumentAttribute documentAttribute );
73
74 /**
75 * Load the data of DocumentAttribute from the table
76 *
77 * @param nAttributeId
78 * The attribute Id
79 * @return the instance of the DocumentAttribute
80 */
81 DocumentAttribute load( int nAttributeId );
82
83 /**
84 * Gets Attribute parameters values
85 *
86 * @param nAttributeId
87 * The attribute Id
88 * @return List of attribute parameters values
89 */
90 List<AttributeTypeParameter> selectAttributeParametersValues( int nAttributeId );
91
92 /**
93 * Add attributes to a document
94 *
95 * @param documentType
96 * The document Type
97 */
98 void selectAttributesByDocumentType( DocumentType documentType );
99
100 /**
101 * Get all attributes of document type
102 *
103 * @param codeDocumentType
104 * The code document Type
105 * @return listDocumentAttributes The list of all attributes of selected code document type
106 */
107 List<DocumentAttribute> selectAllAttributesOfDocumentType( String codeDocumentType );
108
109 /**
110 * Update the record in the table
111 *
112 * @param documentAttribute
113 * The document attribute
114 */
115 void store( DocumentAttribute documentAttribute );
116
117 /**
118 * Inserts an association between an attribute and a regular expression
119 *
120 * @param nIdAttribute
121 * The identifier of the document attribute
122 * @param nIdExpression
123 * The identifier of the regular expression
124 */
125 void insertRegularExpression( int nIdAttribute, int nIdExpression );
126
127 /**
128 * Deletes an association between an attribute and a regular expression
129 *
130 * @param nIdAttribute
131 * The identifier of the document attribute
132 * @param nIdExpression
133 * The identifier of the regular expression
134 */
135 void deleteRegularExpression( int nIdAttribute, int nIdExpression );
136
137 /**
138 * Loads all regular expression key associated to the attribute and returns them into a collection
139 *
140 * @param nIdAttribute
141 * The identifier of the document attribute
142 * @return A collection of regular expression key
143 */
144 Collection<Integer> selectListRegularExpressionKeyByIdAttribute( int nIdAttribute );
145 }