1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.service.persistence;
24  
25  /**
26   * <a href="PortletPreferencesPersistence.java.html"><b><i>View Source</i></b></a>
27   *
28   * @author Brian Wing Shun Chan
29   *
30   */
31  public interface PortletPreferencesPersistence extends BasePersistence {
32      public void cacheResult(
33          com.liferay.portal.model.PortletPreferences portletPreferences);
34  
35      public void cacheResult(
36          java.util.List<com.liferay.portal.model.PortletPreferences> portletPreferenceses);
37  
38      public void clearCache();
39  
40      public com.liferay.portal.model.PortletPreferences create(
41          long portletPreferencesId);
42  
43      public com.liferay.portal.model.PortletPreferences remove(
44          long portletPreferencesId)
45          throws com.liferay.portal.NoSuchPortletPreferencesException,
46              com.liferay.portal.SystemException;
47  
48      public com.liferay.portal.model.PortletPreferences remove(
49          com.liferay.portal.model.PortletPreferences portletPreferences)
50          throws com.liferay.portal.SystemException;
51  
52      /**
53       * @deprecated Use <code>update(PortletPreferences portletPreferences, boolean merge)</code>.
54       */
55      public com.liferay.portal.model.PortletPreferences update(
56          com.liferay.portal.model.PortletPreferences portletPreferences)
57          throws com.liferay.portal.SystemException;
58  
59      /**
60       * Add, update, or merge, the entity. This method also calls the model
61       * listeners to trigger the proper events associated with adding, deleting,
62       * or updating an entity.
63       *
64       * @param        portletPreferences the entity to add, update, or merge
65       * @param        merge boolean value for whether to merge the entity. The
66       *                default value is false. Setting merge to true is more
67       *                expensive and should only be true when portletPreferences is
68       *                transient. See LEP-5473 for a detailed discussion of this
69       *                method.
70       * @return        true if the portlet can be displayed via Ajax
71       */
72      public com.liferay.portal.model.PortletPreferences update(
73          com.liferay.portal.model.PortletPreferences portletPreferences,
74          boolean merge) throws com.liferay.portal.SystemException;
75  
76      public com.liferay.portal.model.PortletPreferences updateImpl(
77          com.liferay.portal.model.PortletPreferences portletPreferences,
78          boolean merge) throws com.liferay.portal.SystemException;
79  
80      public com.liferay.portal.model.PortletPreferences findByPrimaryKey(
81          long portletPreferencesId)
82          throws com.liferay.portal.NoSuchPortletPreferencesException,
83              com.liferay.portal.SystemException;
84  
85      public com.liferay.portal.model.PortletPreferences fetchByPrimaryKey(
86          long portletPreferencesId) throws com.liferay.portal.SystemException;
87  
88      public java.util.List<com.liferay.portal.model.PortletPreferences> findByPlid(
89          long plid) throws com.liferay.portal.SystemException;
90  
91      public java.util.List<com.liferay.portal.model.PortletPreferences> findByPlid(
92          long plid, int start, int end)
93          throws com.liferay.portal.SystemException;
94  
95      public java.util.List<com.liferay.portal.model.PortletPreferences> findByPlid(
96          long plid, int start, int end,
97          com.liferay.portal.kernel.util.OrderByComparator obc)
98          throws com.liferay.portal.SystemException;
99  
100     public com.liferay.portal.model.PortletPreferences findByPlid_First(
101         long plid, com.liferay.portal.kernel.util.OrderByComparator obc)
102         throws com.liferay.portal.NoSuchPortletPreferencesException,
103             com.liferay.portal.SystemException;
104 
105     public com.liferay.portal.model.PortletPreferences findByPlid_Last(
106         long plid, com.liferay.portal.kernel.util.OrderByComparator obc)
107         throws com.liferay.portal.NoSuchPortletPreferencesException,
108             com.liferay.portal.SystemException;
109 
110     public com.liferay.portal.model.PortletPreferences[] findByPlid_PrevAndNext(
111         long portletPreferencesId, long plid,
112         com.liferay.portal.kernel.util.OrderByComparator obc)
113         throws com.liferay.portal.NoSuchPortletPreferencesException,
114             com.liferay.portal.SystemException;
115 
116     public java.util.List<com.liferay.portal.model.PortletPreferences> findByP_P(
117         long plid, java.lang.String portletId)
118         throws com.liferay.portal.SystemException;
119 
120     public java.util.List<com.liferay.portal.model.PortletPreferences> findByP_P(
121         long plid, java.lang.String portletId, int start, int end)
122         throws com.liferay.portal.SystemException;
123 
124     public java.util.List<com.liferay.portal.model.PortletPreferences> findByP_P(
125         long plid, java.lang.String portletId, int start, int end,
126         com.liferay.portal.kernel.util.OrderByComparator obc)
127         throws com.liferay.portal.SystemException;
128 
129     public com.liferay.portal.model.PortletPreferences findByP_P_First(
130         long plid, java.lang.String portletId,
131         com.liferay.portal.kernel.util.OrderByComparator obc)
132         throws com.liferay.portal.NoSuchPortletPreferencesException,
133             com.liferay.portal.SystemException;
134 
135     public com.liferay.portal.model.PortletPreferences findByP_P_Last(
136         long plid, java.lang.String portletId,
137         com.liferay.portal.kernel.util.OrderByComparator obc)
138         throws com.liferay.portal.NoSuchPortletPreferencesException,
139             com.liferay.portal.SystemException;
140 
141     public com.liferay.portal.model.PortletPreferences[] findByP_P_PrevAndNext(
142         long portletPreferencesId, long plid, java.lang.String portletId,
143         com.liferay.portal.kernel.util.OrderByComparator obc)
144         throws com.liferay.portal.NoSuchPortletPreferencesException,
145             com.liferay.portal.SystemException;
146 
147     public java.util.List<com.liferay.portal.model.PortletPreferences> findByO_O_P(
148         long ownerId, int ownerType, long plid)
149         throws com.liferay.portal.SystemException;
150 
151     public java.util.List<com.liferay.portal.model.PortletPreferences> findByO_O_P(
152         long ownerId, int ownerType, long plid, int start, int end)
153         throws com.liferay.portal.SystemException;
154 
155     public java.util.List<com.liferay.portal.model.PortletPreferences> findByO_O_P(
156         long ownerId, int ownerType, long plid, int start, int end,
157         com.liferay.portal.kernel.util.OrderByComparator obc)
158         throws com.liferay.portal.SystemException;
159 
160     public com.liferay.portal.model.PortletPreferences findByO_O_P_First(
161         long ownerId, int ownerType, long plid,
162         com.liferay.portal.kernel.util.OrderByComparator obc)
163         throws com.liferay.portal.NoSuchPortletPreferencesException,
164             com.liferay.portal.SystemException;
165 
166     public com.liferay.portal.model.PortletPreferences findByO_O_P_Last(
167         long ownerId, int ownerType, long plid,
168         com.liferay.portal.kernel.util.OrderByComparator obc)
169         throws com.liferay.portal.NoSuchPortletPreferencesException,
170             com.liferay.portal.SystemException;
171 
172     public com.liferay.portal.model.PortletPreferences[] findByO_O_P_PrevAndNext(
173         long portletPreferencesId, long ownerId, int ownerType, long plid,
174         com.liferay.portal.kernel.util.OrderByComparator obc)
175         throws com.liferay.portal.NoSuchPortletPreferencesException,
176             com.liferay.portal.SystemException;
177 
178     public com.liferay.portal.model.PortletPreferences findByO_O_P_P(
179         long ownerId, int ownerType, long plid, java.lang.String portletId)
180         throws com.liferay.portal.NoSuchPortletPreferencesException,
181             com.liferay.portal.SystemException;
182 
183     public com.liferay.portal.model.PortletPreferences fetchByO_O_P_P(
184         long ownerId, int ownerType, long plid, java.lang.String portletId)
185         throws com.liferay.portal.SystemException;
186 
187     public com.liferay.portal.model.PortletPreferences fetchByO_O_P_P(
188         long ownerId, int ownerType, long plid, java.lang.String portletId,
189         boolean retrieveFromCache) throws com.liferay.portal.SystemException;
190 
191     public java.util.List<Object> findWithDynamicQuery(
192         com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
193         throws com.liferay.portal.SystemException;
194 
195     public java.util.List<Object> findWithDynamicQuery(
196         com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
197         int end) throws com.liferay.portal.SystemException;
198 
199     public java.util.List<com.liferay.portal.model.PortletPreferences> findAll()
200         throws com.liferay.portal.SystemException;
201 
202     public java.util.List<com.liferay.portal.model.PortletPreferences> findAll(
203         int start, int end) throws com.liferay.portal.SystemException;
204 
205     public java.util.List<com.liferay.portal.model.PortletPreferences> findAll(
206         int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
207         throws com.liferay.portal.SystemException;
208 
209     public void removeByPlid(long plid)
210         throws com.liferay.portal.SystemException;
211 
212     public void removeByP_P(long plid, java.lang.String portletId)
213         throws com.liferay.portal.SystemException;
214 
215     public void removeByO_O_P(long ownerId, int ownerType, long plid)
216         throws com.liferay.portal.SystemException;
217 
218     public void removeByO_O_P_P(long ownerId, int ownerType, long plid,
219         java.lang.String portletId)
220         throws com.liferay.portal.NoSuchPortletPreferencesException,
221             com.liferay.portal.SystemException;
222 
223     public void removeAll() throws com.liferay.portal.SystemException;
224 
225     public int countByPlid(long plid) throws com.liferay.portal.SystemException;
226 
227     public int countByP_P(long plid, java.lang.String portletId)
228         throws com.liferay.portal.SystemException;
229 
230     public int countByO_O_P(long ownerId, int ownerType, long plid)
231         throws com.liferay.portal.SystemException;
232 
233     public int countByO_O_P_P(long ownerId, int ownerType, long plid,
234         java.lang.String portletId) throws com.liferay.portal.SystemException;
235 
236     public int countAll() throws com.liferay.portal.SystemException;
237 }