001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service.persistence;
016    
017    import com.liferay.portal.model.PluginSetting;
018    
019    /**
020     * The persistence interface for the plugin setting service.
021     *
022     * <p>
023     * Never modify this interface directly. Modify <code>service.xml</code> and rerun ServiceBuilder to regnerate this interface.
024     * </p>
025     *
026     * @author Brian Wing Shun Chan
027     * @see PluginSettingPersistenceImpl
028     * @see PluginSettingUtil
029     * @generated
030     */
031    public interface PluginSettingPersistence extends BasePersistence<PluginSetting> {
032            /**
033            * Caches the plugin setting in the entity cache if it is enabled.
034            *
035            * @param pluginSetting the plugin setting to cache
036            */
037            public void cacheResult(
038                    com.liferay.portal.model.PluginSetting pluginSetting);
039    
040            /**
041            * Caches the plugin settings in the entity cache if it is enabled.
042            *
043            * @param pluginSettings the plugin settings to cache
044            */
045            public void cacheResult(
046                    java.util.List<com.liferay.portal.model.PluginSetting> pluginSettings);
047    
048            /**
049            * Creates a new plugin setting with the primary key.
050            *
051            * @param pluginSettingId the primary key for the new plugin setting
052            * @return the new plugin setting
053            */
054            public com.liferay.portal.model.PluginSetting create(long pluginSettingId);
055    
056            /**
057            * Removes the plugin setting with the primary key from the database. Also notifies the appropriate model listeners.
058            *
059            * @param pluginSettingId the primary key of the plugin setting to remove
060            * @return the plugin setting that was removed
061            * @throws com.liferay.portal.NoSuchPluginSettingException if a plugin setting with the primary key could not be found
062            * @throws SystemException if a system exception occurred
063            */
064            public com.liferay.portal.model.PluginSetting remove(long pluginSettingId)
065                    throws com.liferay.portal.NoSuchPluginSettingException,
066                            com.liferay.portal.kernel.exception.SystemException;
067    
068            public com.liferay.portal.model.PluginSetting updateImpl(
069                    com.liferay.portal.model.PluginSetting pluginSetting, boolean merge)
070                    throws com.liferay.portal.kernel.exception.SystemException;
071    
072            /**
073            * Finds the plugin setting with the primary key or throws a {@link com.liferay.portal.NoSuchPluginSettingException} if it could not be found.
074            *
075            * @param pluginSettingId the primary key of the plugin setting to find
076            * @return the plugin setting
077            * @throws com.liferay.portal.NoSuchPluginSettingException if a plugin setting with the primary key could not be found
078            * @throws SystemException if a system exception occurred
079            */
080            public com.liferay.portal.model.PluginSetting findByPrimaryKey(
081                    long pluginSettingId)
082                    throws com.liferay.portal.NoSuchPluginSettingException,
083                            com.liferay.portal.kernel.exception.SystemException;
084    
085            /**
086            * Finds the plugin setting with the primary key or returns <code>null</code> if it could not be found.
087            *
088            * @param pluginSettingId the primary key of the plugin setting to find
089            * @return the plugin setting, or <code>null</code> if a plugin setting with the primary key could not be found
090            * @throws SystemException if a system exception occurred
091            */
092            public com.liferay.portal.model.PluginSetting fetchByPrimaryKey(
093                    long pluginSettingId)
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            /**
097            * Finds all the plugin settings where companyId = &#63;.
098            *
099            * @param companyId the company id to search with
100            * @return the matching plugin settings
101            * @throws SystemException if a system exception occurred
102            */
103            public java.util.List<com.liferay.portal.model.PluginSetting> findByCompanyId(
104                    long companyId)
105                    throws com.liferay.portal.kernel.exception.SystemException;
106    
107            /**
108            * Finds a range of all the plugin settings where companyId = &#63;.
109            *
110            * <p>
111            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
112            * </p>
113            *
114            * @param companyId the company id to search with
115            * @param start the lower bound of the range of plugin settings to return
116            * @param end the upper bound of the range of plugin settings to return (not inclusive)
117            * @return the range of matching plugin settings
118            * @throws SystemException if a system exception occurred
119            */
120            public java.util.List<com.liferay.portal.model.PluginSetting> findByCompanyId(
121                    long companyId, int start, int end)
122                    throws com.liferay.portal.kernel.exception.SystemException;
123    
124            /**
125            * Finds an ordered range of all the plugin settings where companyId = &#63;.
126            *
127            * <p>
128            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
129            * </p>
130            *
131            * @param companyId the company id to search with
132            * @param start the lower bound of the range of plugin settings to return
133            * @param end the upper bound of the range of plugin settings to return (not inclusive)
134            * @param orderByComparator the comparator to order the results by
135            * @return the ordered range of matching plugin settings
136            * @throws SystemException if a system exception occurred
137            */
138            public java.util.List<com.liferay.portal.model.PluginSetting> findByCompanyId(
139                    long companyId, int start, int end,
140                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
141                    throws com.liferay.portal.kernel.exception.SystemException;
142    
143            /**
144            * Finds the first plugin setting in the ordered set where companyId = &#63;.
145            *
146            * <p>
147            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
148            * </p>
149            *
150            * @param companyId the company id to search with
151            * @param orderByComparator the comparator to order the set by
152            * @return the first matching plugin setting
153            * @throws com.liferay.portal.NoSuchPluginSettingException if a matching plugin setting could not be found
154            * @throws SystemException if a system exception occurred
155            */
156            public com.liferay.portal.model.PluginSetting findByCompanyId_First(
157                    long companyId,
158                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
159                    throws com.liferay.portal.NoSuchPluginSettingException,
160                            com.liferay.portal.kernel.exception.SystemException;
161    
162            /**
163            * Finds the last plugin setting in the ordered set where companyId = &#63;.
164            *
165            * <p>
166            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
167            * </p>
168            *
169            * @param companyId the company id to search with
170            * @param orderByComparator the comparator to order the set by
171            * @return the last matching plugin setting
172            * @throws com.liferay.portal.NoSuchPluginSettingException if a matching plugin setting could not be found
173            * @throws SystemException if a system exception occurred
174            */
175            public com.liferay.portal.model.PluginSetting findByCompanyId_Last(
176                    long companyId,
177                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
178                    throws com.liferay.portal.NoSuchPluginSettingException,
179                            com.liferay.portal.kernel.exception.SystemException;
180    
181            /**
182            * Finds the plugin settings before and after the current plugin setting in the ordered set where companyId = &#63;.
183            *
184            * <p>
185            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
186            * </p>
187            *
188            * @param pluginSettingId the primary key of the current plugin setting
189            * @param companyId the company id to search with
190            * @param orderByComparator the comparator to order the set by
191            * @return the previous, current, and next plugin setting
192            * @throws com.liferay.portal.NoSuchPluginSettingException if a plugin setting with the primary key could not be found
193            * @throws SystemException if a system exception occurred
194            */
195            public com.liferay.portal.model.PluginSetting[] findByCompanyId_PrevAndNext(
196                    long pluginSettingId, long companyId,
197                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
198                    throws com.liferay.portal.NoSuchPluginSettingException,
199                            com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Finds the plugin setting where companyId = &#63; and pluginId = &#63; and pluginType = &#63; or throws a {@link com.liferay.portal.NoSuchPluginSettingException} if it could not be found.
203            *
204            * @param companyId the company id to search with
205            * @param pluginId the plugin id to search with
206            * @param pluginType the plugin type to search with
207            * @return the matching plugin setting
208            * @throws com.liferay.portal.NoSuchPluginSettingException if a matching plugin setting could not be found
209            * @throws SystemException if a system exception occurred
210            */
211            public com.liferay.portal.model.PluginSetting findByC_I_T(long companyId,
212                    java.lang.String pluginId, java.lang.String pluginType)
213                    throws com.liferay.portal.NoSuchPluginSettingException,
214                            com.liferay.portal.kernel.exception.SystemException;
215    
216            /**
217            * Finds the plugin setting where companyId = &#63; and pluginId = &#63; and pluginType = &#63; or returns <code>null</code> if it could not be found. Uses the finder cache.
218            *
219            * @param companyId the company id to search with
220            * @param pluginId the plugin id to search with
221            * @param pluginType the plugin type to search with
222            * @return the matching plugin setting, or <code>null</code> if a matching plugin setting could not be found
223            * @throws SystemException if a system exception occurred
224            */
225            public com.liferay.portal.model.PluginSetting fetchByC_I_T(long companyId,
226                    java.lang.String pluginId, java.lang.String pluginType)
227                    throws com.liferay.portal.kernel.exception.SystemException;
228    
229            /**
230            * Finds the plugin setting where companyId = &#63; and pluginId = &#63; and pluginType = &#63; or returns <code>null</code> if it could not be found, optionally using the finder cache.
231            *
232            * @param companyId the company id to search with
233            * @param pluginId the plugin id to search with
234            * @param pluginType the plugin type to search with
235            * @return the matching plugin setting, or <code>null</code> if a matching plugin setting could not be found
236            * @throws SystemException if a system exception occurred
237            */
238            public com.liferay.portal.model.PluginSetting fetchByC_I_T(long companyId,
239                    java.lang.String pluginId, java.lang.String pluginType,
240                    boolean retrieveFromCache)
241                    throws com.liferay.portal.kernel.exception.SystemException;
242    
243            /**
244            * Finds all the plugin settings.
245            *
246            * @return the plugin settings
247            * @throws SystemException if a system exception occurred
248            */
249            public java.util.List<com.liferay.portal.model.PluginSetting> findAll()
250                    throws com.liferay.portal.kernel.exception.SystemException;
251    
252            /**
253            * Finds a range of all the plugin settings.
254            *
255            * <p>
256            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
257            * </p>
258            *
259            * @param start the lower bound of the range of plugin settings to return
260            * @param end the upper bound of the range of plugin settings to return (not inclusive)
261            * @return the range of plugin settings
262            * @throws SystemException if a system exception occurred
263            */
264            public java.util.List<com.liferay.portal.model.PluginSetting> findAll(
265                    int start, int end)
266                    throws com.liferay.portal.kernel.exception.SystemException;
267    
268            /**
269            * Finds an ordered range of all the plugin settings.
270            *
271            * <p>
272            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
273            * </p>
274            *
275            * @param start the lower bound of the range of plugin settings to return
276            * @param end the upper bound of the range of plugin settings to return (not inclusive)
277            * @param orderByComparator the comparator to order the results by
278            * @return the ordered range of plugin settings
279            * @throws SystemException if a system exception occurred
280            */
281            public java.util.List<com.liferay.portal.model.PluginSetting> findAll(
282                    int start, int end,
283                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
284                    throws com.liferay.portal.kernel.exception.SystemException;
285    
286            /**
287            * Removes all the plugin settings where companyId = &#63; from the database.
288            *
289            * @param companyId the company id to search with
290            * @throws SystemException if a system exception occurred
291            */
292            public void removeByCompanyId(long companyId)
293                    throws com.liferay.portal.kernel.exception.SystemException;
294    
295            /**
296            * Removes the plugin setting where companyId = &#63; and pluginId = &#63; and pluginType = &#63; from the database.
297            *
298            * @param companyId the company id to search with
299            * @param pluginId the plugin id to search with
300            * @param pluginType the plugin type to search with
301            * @throws SystemException if a system exception occurred
302            */
303            public void removeByC_I_T(long companyId, java.lang.String pluginId,
304                    java.lang.String pluginType)
305                    throws com.liferay.portal.NoSuchPluginSettingException,
306                            com.liferay.portal.kernel.exception.SystemException;
307    
308            /**
309            * Removes all the plugin settings from the database.
310            *
311            * @throws SystemException if a system exception occurred
312            */
313            public void removeAll()
314                    throws com.liferay.portal.kernel.exception.SystemException;
315    
316            /**
317            * Counts all the plugin settings where companyId = &#63;.
318            *
319            * @param companyId the company id to search with
320            * @return the number of matching plugin settings
321            * @throws SystemException if a system exception occurred
322            */
323            public int countByCompanyId(long companyId)
324                    throws com.liferay.portal.kernel.exception.SystemException;
325    
326            /**
327            * Counts all the plugin settings where companyId = &#63; and pluginId = &#63; and pluginType = &#63;.
328            *
329            * @param companyId the company id to search with
330            * @param pluginId the plugin id to search with
331            * @param pluginType the plugin type to search with
332            * @return the number of matching plugin settings
333            * @throws SystemException if a system exception occurred
334            */
335            public int countByC_I_T(long companyId, java.lang.String pluginId,
336                    java.lang.String pluginType)
337                    throws com.liferay.portal.kernel.exception.SystemException;
338    
339            /**
340            * Counts all the plugin settings.
341            *
342            * @return the number of plugin settings
343            * @throws SystemException if a system exception occurred
344            */
345            public int countAll()
346                    throws com.liferay.portal.kernel.exception.SystemException;
347    }