001    /**
002     * Copyright (c) 2000-2013 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     * Caching information and settings can be found in <code>portal.properties</code>
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             * NOTE FOR DEVELOPERS:
034             *
035             * Never modify or reference this interface directly. Always use {@link PluginSettingUtil} to access the plugin setting persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface.
036             */
037    
038            /**
039            * Caches the plugin setting in the entity cache if it is enabled.
040            *
041            * @param pluginSetting the plugin setting
042            */
043            public void cacheResult(
044                    com.liferay.portal.model.PluginSetting pluginSetting);
045    
046            /**
047            * Caches the plugin settings in the entity cache if it is enabled.
048            *
049            * @param pluginSettings the plugin settings
050            */
051            public void cacheResult(
052                    java.util.List<com.liferay.portal.model.PluginSetting> pluginSettings);
053    
054            /**
055            * Creates a new plugin setting with the primary key. Does not add the plugin setting to the database.
056            *
057            * @param pluginSettingId the primary key for the new plugin setting
058            * @return the new plugin setting
059            */
060            public com.liferay.portal.model.PluginSetting create(long pluginSettingId);
061    
062            /**
063            * Removes the plugin setting with the primary key from the database. Also notifies the appropriate model listeners.
064            *
065            * @param pluginSettingId the primary key of the plugin setting
066            * @return the plugin setting that was removed
067            * @throws com.liferay.portal.NoSuchPluginSettingException if a plugin setting with the primary key could not be found
068            * @throws SystemException if a system exception occurred
069            */
070            public com.liferay.portal.model.PluginSetting remove(long pluginSettingId)
071                    throws com.liferay.portal.NoSuchPluginSettingException,
072                            com.liferay.portal.kernel.exception.SystemException;
073    
074            public com.liferay.portal.model.PluginSetting updateImpl(
075                    com.liferay.portal.model.PluginSetting pluginSetting, boolean merge)
076                    throws com.liferay.portal.kernel.exception.SystemException;
077    
078            /**
079            * Returns the plugin setting with the primary key or throws a {@link com.liferay.portal.NoSuchPluginSettingException} if it could not be found.
080            *
081            * @param pluginSettingId the primary key of the plugin setting
082            * @return the plugin setting
083            * @throws com.liferay.portal.NoSuchPluginSettingException if a plugin setting with the primary key could not be found
084            * @throws SystemException if a system exception occurred
085            */
086            public com.liferay.portal.model.PluginSetting findByPrimaryKey(
087                    long pluginSettingId)
088                    throws com.liferay.portal.NoSuchPluginSettingException,
089                            com.liferay.portal.kernel.exception.SystemException;
090    
091            /**
092            * Returns the plugin setting with the primary key or returns <code>null</code> if it could not be found.
093            *
094            * @param pluginSettingId the primary key of the plugin setting
095            * @return the plugin setting, or <code>null</code> if a plugin setting with the primary key could not be found
096            * @throws SystemException if a system exception occurred
097            */
098            public com.liferay.portal.model.PluginSetting fetchByPrimaryKey(
099                    long pluginSettingId)
100                    throws com.liferay.portal.kernel.exception.SystemException;
101    
102            /**
103            * Returns all the plugin settings where companyId = &#63;.
104            *
105            * @param companyId the company ID
106            * @return the matching plugin settings
107            * @throws SystemException if a system exception occurred
108            */
109            public java.util.List<com.liferay.portal.model.PluginSetting> findByCompanyId(
110                    long companyId)
111                    throws com.liferay.portal.kernel.exception.SystemException;
112    
113            /**
114            * Returns a range of all the plugin settings where companyId = &#63;.
115            *
116            * <p>
117            * 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.
118            * </p>
119            *
120            * @param companyId the company ID
121            * @param start the lower bound of the range of plugin settings
122            * @param end the upper bound of the range of plugin settings (not inclusive)
123            * @return the range of matching plugin settings
124            * @throws SystemException if a system exception occurred
125            */
126            public java.util.List<com.liferay.portal.model.PluginSetting> findByCompanyId(
127                    long companyId, int start, int end)
128                    throws com.liferay.portal.kernel.exception.SystemException;
129    
130            /**
131            * Returns an ordered range of all the plugin settings where companyId = &#63;.
132            *
133            * <p>
134            * 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.
135            * </p>
136            *
137            * @param companyId the company ID
138            * @param start the lower bound of the range of plugin settings
139            * @param end the upper bound of the range of plugin settings (not inclusive)
140            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
141            * @return the ordered range of matching plugin settings
142            * @throws SystemException if a system exception occurred
143            */
144            public java.util.List<com.liferay.portal.model.PluginSetting> findByCompanyId(
145                    long companyId, int start, int end,
146                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
147                    throws com.liferay.portal.kernel.exception.SystemException;
148    
149            /**
150            * Returns the first plugin setting in the ordered set where companyId = &#63;.
151            *
152            * @param companyId the company ID
153            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
154            * @return the first matching plugin setting
155            * @throws com.liferay.portal.NoSuchPluginSettingException if a matching plugin setting could not be found
156            * @throws SystemException if a system exception occurred
157            */
158            public com.liferay.portal.model.PluginSetting findByCompanyId_First(
159                    long companyId,
160                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
161                    throws com.liferay.portal.NoSuchPluginSettingException,
162                            com.liferay.portal.kernel.exception.SystemException;
163    
164            /**
165            * Returns the first plugin setting in the ordered set where companyId = &#63;.
166            *
167            * @param companyId the company ID
168            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
169            * @return the first matching plugin setting, or <code>null</code> if a matching plugin setting could not be found
170            * @throws SystemException if a system exception occurred
171            */
172            public com.liferay.portal.model.PluginSetting fetchByCompanyId_First(
173                    long companyId,
174                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
175                    throws com.liferay.portal.kernel.exception.SystemException;
176    
177            /**
178            * Returns the last plugin setting in the ordered set where companyId = &#63;.
179            *
180            * @param companyId the company ID
181            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
182            * @return the last matching plugin setting
183            * @throws com.liferay.portal.NoSuchPluginSettingException if a matching plugin setting could not be found
184            * @throws SystemException if a system exception occurred
185            */
186            public com.liferay.portal.model.PluginSetting findByCompanyId_Last(
187                    long companyId,
188                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
189                    throws com.liferay.portal.NoSuchPluginSettingException,
190                            com.liferay.portal.kernel.exception.SystemException;
191    
192            /**
193            * Returns the last plugin setting in the ordered set where companyId = &#63;.
194            *
195            * @param companyId the company ID
196            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
197            * @return the last matching plugin setting, or <code>null</code> if a matching plugin setting could not be found
198            * @throws SystemException if a system exception occurred
199            */
200            public com.liferay.portal.model.PluginSetting fetchByCompanyId_Last(
201                    long companyId,
202                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
203                    throws com.liferay.portal.kernel.exception.SystemException;
204    
205            /**
206            * Returns the plugin settings before and after the current plugin setting in the ordered set where companyId = &#63;.
207            *
208            * @param pluginSettingId the primary key of the current plugin setting
209            * @param companyId the company ID
210            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
211            * @return the previous, current, and next plugin setting
212            * @throws com.liferay.portal.NoSuchPluginSettingException if a plugin setting with the primary key could not be found
213            * @throws SystemException if a system exception occurred
214            */
215            public com.liferay.portal.model.PluginSetting[] findByCompanyId_PrevAndNext(
216                    long pluginSettingId, long companyId,
217                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
218                    throws com.liferay.portal.NoSuchPluginSettingException,
219                            com.liferay.portal.kernel.exception.SystemException;
220    
221            /**
222            * Returns 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.
223            *
224            * @param companyId the company ID
225            * @param pluginId the plugin ID
226            * @param pluginType the plugin type
227            * @return the matching plugin setting
228            * @throws com.liferay.portal.NoSuchPluginSettingException if a matching plugin setting could not be found
229            * @throws SystemException if a system exception occurred
230            */
231            public com.liferay.portal.model.PluginSetting findByC_I_T(long companyId,
232                    java.lang.String pluginId, java.lang.String pluginType)
233                    throws com.liferay.portal.NoSuchPluginSettingException,
234                            com.liferay.portal.kernel.exception.SystemException;
235    
236            /**
237            * Returns 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.
238            *
239            * @param companyId the company ID
240            * @param pluginId the plugin ID
241            * @param pluginType the plugin type
242            * @return the matching plugin setting, or <code>null</code> if a matching plugin setting could not be found
243            * @throws SystemException if a system exception occurred
244            */
245            public com.liferay.portal.model.PluginSetting fetchByC_I_T(long companyId,
246                    java.lang.String pluginId, java.lang.String pluginType)
247                    throws com.liferay.portal.kernel.exception.SystemException;
248    
249            /**
250            * Returns 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.
251            *
252            * @param companyId the company ID
253            * @param pluginId the plugin ID
254            * @param pluginType the plugin type
255            * @param retrieveFromCache whether to use the finder cache
256            * @return the matching plugin setting, or <code>null</code> if a matching plugin setting could not be found
257            * @throws SystemException if a system exception occurred
258            */
259            public com.liferay.portal.model.PluginSetting fetchByC_I_T(long companyId,
260                    java.lang.String pluginId, java.lang.String pluginType,
261                    boolean retrieveFromCache)
262                    throws com.liferay.portal.kernel.exception.SystemException;
263    
264            /**
265            * Returns all the plugin settings.
266            *
267            * @return the plugin settings
268            * @throws SystemException if a system exception occurred
269            */
270            public java.util.List<com.liferay.portal.model.PluginSetting> findAll()
271                    throws com.liferay.portal.kernel.exception.SystemException;
272    
273            /**
274            * Returns a range of all the plugin settings.
275            *
276            * <p>
277            * 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.
278            * </p>
279            *
280            * @param start the lower bound of the range of plugin settings
281            * @param end the upper bound of the range of plugin settings (not inclusive)
282            * @return the range of plugin settings
283            * @throws SystemException if a system exception occurred
284            */
285            public java.util.List<com.liferay.portal.model.PluginSetting> findAll(
286                    int start, int end)
287                    throws com.liferay.portal.kernel.exception.SystemException;
288    
289            /**
290            * Returns an ordered range of all the plugin settings.
291            *
292            * <p>
293            * 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.
294            * </p>
295            *
296            * @param start the lower bound of the range of plugin settings
297            * @param end the upper bound of the range of plugin settings (not inclusive)
298            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
299            * @return the ordered range of plugin settings
300            * @throws SystemException if a system exception occurred
301            */
302            public java.util.List<com.liferay.portal.model.PluginSetting> findAll(
303                    int start, int end,
304                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
305                    throws com.liferay.portal.kernel.exception.SystemException;
306    
307            /**
308            * Removes all the plugin settings where companyId = &#63; from the database.
309            *
310            * @param companyId the company ID
311            * @throws SystemException if a system exception occurred
312            */
313            public void removeByCompanyId(long companyId)
314                    throws com.liferay.portal.kernel.exception.SystemException;
315    
316            /**
317            * Removes the plugin setting where companyId = &#63; and pluginId = &#63; and pluginType = &#63; from the database.
318            *
319            * @param companyId the company ID
320            * @param pluginId the plugin ID
321            * @param pluginType the plugin type
322            * @return the plugin setting that was removed
323            * @throws SystemException if a system exception occurred
324            */
325            public com.liferay.portal.model.PluginSetting removeByC_I_T(
326                    long companyId, java.lang.String pluginId, java.lang.String pluginType)
327                    throws com.liferay.portal.NoSuchPluginSettingException,
328                            com.liferay.portal.kernel.exception.SystemException;
329    
330            /**
331            * Removes all the plugin settings from the database.
332            *
333            * @throws SystemException if a system exception occurred
334            */
335            public void removeAll()
336                    throws com.liferay.portal.kernel.exception.SystemException;
337    
338            /**
339            * Returns the number of plugin settings where companyId = &#63;.
340            *
341            * @param companyId the company ID
342            * @return the number of matching plugin settings
343            * @throws SystemException if a system exception occurred
344            */
345            public int countByCompanyId(long companyId)
346                    throws com.liferay.portal.kernel.exception.SystemException;
347    
348            /**
349            * Returns the number of plugin settings where companyId = &#63; and pluginId = &#63; and pluginType = &#63;.
350            *
351            * @param companyId the company ID
352            * @param pluginId the plugin ID
353            * @param pluginType the plugin type
354            * @return the number of matching plugin settings
355            * @throws SystemException if a system exception occurred
356            */
357            public int countByC_I_T(long companyId, java.lang.String pluginId,
358                    java.lang.String pluginType)
359                    throws com.liferay.portal.kernel.exception.SystemException;
360    
361            /**
362            * Returns the number of plugin settings.
363            *
364            * @return the number of plugin settings
365            * @throws SystemException if a system exception occurred
366            */
367            public int countAll()
368                    throws com.liferay.portal.kernel.exception.SystemException;
369    }