|
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.wiki.business; |
35 | | - |
36 | | -import fr.paris.lutece.portal.service.plugin.Plugin; |
37 | | - |
38 | | -import java.util.List; |
39 | | - |
40 | | -/** |
41 | | - * |
42 | | - * IImageDAO |
43 | | - * |
44 | | - */ |
45 | | -public interface IImageDAO |
46 | | -{ |
47 | | - /** |
48 | | - * Insert a new record in the table. |
49 | | - * |
50 | | - * @param image |
51 | | - * instance of the Image object to insert |
52 | | - * @param plugin |
53 | | - * the plugin |
54 | | - */ |
55 | | - void insert( Image image, Plugin plugin ); |
56 | | - |
57 | | - /** |
58 | | - * update record in the table. |
59 | | - * |
60 | | - * @param image |
61 | | - * instance of the Image object to update |
62 | | - * @param plugin |
63 | | - * the plugin |
64 | | - */ |
65 | | - void store( Image image, Plugin plugin ); |
66 | | - |
67 | | - /** |
68 | | - * update image metadata in the table. |
69 | | - * |
70 | | - * @param image |
71 | | - * instance of the Image object to update |
72 | | - * @param plugin |
73 | | - * the plugin |
74 | | - */ |
75 | | - void storeMetadata( Image image, Plugin plugin ); |
76 | | - |
77 | | - /** |
78 | | - * Load the image Object |
79 | | - * |
80 | | - * @param nIdImage |
81 | | - * the image id |
82 | | - * @param plugin |
83 | | - * the plugin |
84 | | - * @return the image Object |
85 | | - */ |
86 | | - Image load( int nIdImage, Plugin plugin ); |
87 | | - |
88 | | - /** |
89 | | - * Delete the Image Object |
90 | | - * |
91 | | - * @param nIdImage |
92 | | - * theimage id |
93 | | - * @param plugin |
94 | | - * the plugin |
95 | | - */ |
96 | | - void delete( int nIdImage, Plugin plugin ); |
97 | | - |
98 | | - /** |
99 | | - * select all Images |
100 | | - * |
101 | | - * @param plugin |
102 | | - * the plugin |
103 | | - * @return a list of Image |
104 | | - */ |
105 | | - List<Image> selectAll( Plugin plugin ); |
106 | | - |
107 | | - /** |
108 | | - * select images for a given topic |
109 | | - * |
110 | | - * @param nTopicId |
111 | | - * The topic ID |
112 | | - * @param plugin |
113 | | - * The plugin |
114 | | - * @return The list |
115 | | - */ |
116 | | - List<Image> selectByTopicId( int nTopicId, Plugin plugin ); |
117 | | - |
118 | | - /** |
119 | | - * remove all images associated to a given topic |
120 | | - * |
121 | | - * @param nTopicId |
122 | | - * The Topic ID |
123 | | - * @param plugin |
124 | | - * the Plugin |
125 | | - * |
126 | | - */ |
127 | | - void deleteByTopic( int nTopicId, Plugin plugin ); |
128 | | -} |
| 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.wiki.business; |
| 35 | + |
| 36 | +import fr.paris.lutece.portal.service.plugin.Plugin; |
| 37 | + |
| 38 | +import java.util.List; |
| 39 | + |
| 40 | +/** |
| 41 | + * |
| 42 | + * IImageDAO |
| 43 | + * |
| 44 | + */ |
| 45 | +public interface IImageDAO |
| 46 | +{ |
| 47 | + /** |
| 48 | + * Insert a new record in the table. |
| 49 | + * |
| 50 | + * @param image |
| 51 | + * instance of the Image object to insert |
| 52 | + * @param plugin |
| 53 | + * the plugin |
| 54 | + */ |
| 55 | + void insert( Image image, Plugin plugin ); |
| 56 | + |
| 57 | + /** |
| 58 | + * update record in the table. |
| 59 | + * |
| 60 | + * @param image |
| 61 | + * instance of the Image object to update |
| 62 | + * @param plugin |
| 63 | + * the plugin |
| 64 | + */ |
| 65 | + void store( Image image, Plugin plugin ); |
| 66 | + |
| 67 | + /** |
| 68 | + * update image metadata in the table. |
| 69 | + * |
| 70 | + * @param image |
| 71 | + * instance of the Image object to update |
| 72 | + * @param plugin |
| 73 | + * the plugin |
| 74 | + */ |
| 75 | + void storeMetadata( Image image, Plugin plugin ); |
| 76 | + |
| 77 | + /** |
| 78 | + * Load the image Object |
| 79 | + * |
| 80 | + * @param nIdImage |
| 81 | + * the image id |
| 82 | + * @param plugin |
| 83 | + * the plugin |
| 84 | + * @return the image Object |
| 85 | + */ |
| 86 | + Image load( int nIdImage, Plugin plugin ); |
| 87 | + |
| 88 | + /** |
| 89 | + * Delete the Image Object |
| 90 | + * |
| 91 | + * @param nIdImage |
| 92 | + * theimage id |
| 93 | + * @param plugin |
| 94 | + * the plugin |
| 95 | + */ |
| 96 | + void delete( int nIdImage, Plugin plugin ); |
| 97 | + |
| 98 | + /** |
| 99 | + * select all Images |
| 100 | + * |
| 101 | + * @param plugin |
| 102 | + * the plugin |
| 103 | + * @return a list of Image |
| 104 | + */ |
| 105 | + List<Image> selectAll( Plugin plugin ); |
| 106 | + |
| 107 | + /** |
| 108 | + * select images for a given topic |
| 109 | + * |
| 110 | + * @param nTopicId |
| 111 | + * The topic ID |
| 112 | + * @param plugin |
| 113 | + * The plugin |
| 114 | + * @return The list |
| 115 | + */ |
| 116 | + List<Image> selectByTopicId( int nTopicId, Plugin plugin ); |
| 117 | + |
| 118 | + /** |
| 119 | + * remove all images associated to a given topic |
| 120 | + * |
| 121 | + * @param nTopicId |
| 122 | + * The Topic ID |
| 123 | + * @param plugin |
| 124 | + * the Plugin |
| 125 | + * |
| 126 | + */ |
| 127 | + void deleteByTopic( int nTopicId, Plugin plugin ); |
| 128 | +} |
0 commit comments