1 /*
2 * Copyright (c) 2002-2017, 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.plugins.directory.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.List;
39
40 /**
41 *
42 * Directory action Dao
43 */
44 public interface IDirectoryActionDAO
45 {
46 /**
47 * Load the list of actions for a all directory by directory state
48 *
49 * @param nState
50 * the state of the directory
51 * @param plugin
52 * the plugin
53 * @return The Collection of actions
54 */
55 List<DirectoryAction> selectActionsByDirectoryState( int nState, Plugin plugin );
56
57 /**
58 * Load the list of actions for a all directory by directory state
59 *
60 * @param nState
61 * the state of the directory
62 * @param plugin
63 * the plugin
64 * @return The Collection of actions
65 */
66 List<DirectoryAction> selectActionsByDirectoryRecordState( int nState, Plugin plugin );
67
68 /**
69 * Add a new action for directory record for module which uses plugin-directory
70 *
71 * @param directoryAction
72 * The action builded in module which uses plugin-directory
73 * @param plugin
74 * the plugin
75 */
76 void addNewActionInDirectoryRecordAction( DirectoryAction directoryAction, Plugin plugin );
77
78 /**
79 * Delete a directory record action
80 *
81 * @param plugin
82 * plugin
83 * @param directoryAction
84 * The action to delete
85 */
86 void deleteActionsDirectoryRecord( DirectoryAction directoryAction, Plugin plugin );
87
88 /**
89 * This method checks if an directory record action exists
90 *
91 * @param plugin
92 * plugin
93 * @param directoryAction
94 * The action to check
95 * @return True if the action exists, false otherwise
96 */
97 boolean checkActionsDirectoryRecord( DirectoryAction directoryAction, Plugin plugin );
98
99 /**
100 * Load the list of actions for a all directory Xsl
101 *
102 * @param plugin
103 * the plugin
104 * @return The Collection of actions
105 */
106 List<DirectoryAction> selectActionsByDirectoryXsl( Plugin plugin );
107 }