View Javadoc
1   /*
2    * Copyright (c) 2002-2014, 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.contextinclude.business;
35  
36  import fr.paris.lutece.plugins.contextinclude.util.OperatorEnum;
37  import fr.paris.lutece.portal.service.plugin.Plugin;
38  
39  import java.util.List;
40  
41  
42  /**
43   *
44   * IContextDAO
45   *
46   */
47  public interface IContextDAO
48  {
49      /**
50       * Insert a new context
51       * @param context the context
52       * @param plugin the plugin
53       * @return the new primary key
54       */
55      int insert( Context context, Plugin plugin );
56  
57      /**
58       * Store a context
59       * @param context the context
60       * @param plugin the plugin
61       */
62      void store( Context context, Plugin plugin );
63  
64      /**
65       * Delete the context
66       * @param nIdContext the id context
67       * @param plugin the plugin
68       */
69      void delete( int nIdContext, Plugin plugin );
70  
71      /**
72       * Load a {@link Context}
73       * @param nIdContext the id context
74       * @param plugin the plugin
75       * @return a {@link Context}
76       */
77      Context load( int nIdContext, Plugin plugin );
78  
79      /**
80       * Find all contexts
81       * @param plugin the plugin
82       * @return a list of {@link Context}
83       */
84      List<Context> findAll( Plugin plugin );
85  
86      /**
87       * Find active contexts
88       * @param plugin the plugin
89       * @return a list of {@link Context}
90       */
91      List<Context> findActiveContexts( Plugin plugin );
92  
93      /**
94       * Find by relative priority
95       * @param operator the operator
96       * @param nPriority the priority to compare to
97       * @param plugin the plugin
98       * @return a list of {@link Context}
99       */
100     List<Context> findByRelativePriority( OperatorEnum operator, int nPriority, Plugin plugin );
101 }