View Javadoc
1   /*
2    * Copyright (c) 2002-2024, 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.lutecetools.business;
35  
36  import java.util.List;
37  
38  import fr.paris.lutece.portal.service.plugin.Plugin;
39  
40  public interface IComponentDependencyDAO 
41  {
42  	/**
43       * Insert a new record in the table.
44       * 
45       * @param component
46       *            instance of the Component object to insert
47       * @param dependency
48       *            instance of the Dependency object to insert
49       * @param plugin
50       *            the Plugin
51       */
52      void insert( Component component, Dependency dependency, Plugin plugin );
53  
54      /**
55       * Delete records from the table
56       * 
57       * @param nComponentArtifactId
58       *            The artifact identifier of the component to delete
59       * @param plugin
60       *            the Plugin
61       */
62      void delete( String nComponentArtifactId, Plugin plugin );
63      
64      /**
65       * Delete all records from the table
66       * 
67       * @param plugin
68       *            the Plugin
69       */
70      void deleteAll( Plugin plugin );
71  
72  	/**
73       * Returns the artifact identifiers of all components that depend on a particular component
74       * 
75       * @param nDependencyArtifactId
76       *            The artifact identifier of the component on which other components depend
77       * @param plugin
78       *            the Plugin
79       * @return the list of component artifact identifiers 
80       */
81      List<String> selectDependentComponentArtifactIds( String nDependencyArtifactId , Plugin plugin );
82  }