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