001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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 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.
024     * </p>
025     *
026     * <p>
027     * Caching information and settings can be found in <code>portal.properties</code>
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see PluginSettingPersistenceImpl
032     * @see PluginSettingUtil
033     * @generated
034     */
035    public interface PluginSettingPersistence extends BasePersistence<PluginSetting> {
036            /**
037            * Caches the plugin setting in the entity cache if it is enabled.
038            *
039            * @param pluginSetting the plugin setting to cache
040            */
041            public void cacheResult(
042                    com.liferay.portal.model.PluginSetting pluginSetting);
043    
044            /**
045            * Caches the plugin settings in the entity cache if it is enabled.
046            *
047            * @param pluginSettings the plugin settings to cache
048            */
049            public void cacheResult(
050                    java.util.List<com.liferay.portal.model.PluginSetting> pluginSettings);
051    
052            /**
053            * Creates a new plugin setting with the primary key. Does not add the plugin setting to the database.
054            *
055            * @param pluginSettingId the primary key for the new plugin setting
056            * @return the new plugin setting
057            */
058            public com.liferay.portal.model.PluginSetting create(long pluginSettingId);
059    
060            /**
061            * Removes the plugin setting with the primary key from the database. Also notifies the appropriate model listeners.
062            *
063            * @param pluginSettingId the primary key of the plugin setting to remove
064            * @return the plugin setting that was removed
065            * @throws com.liferay.portal.NoSuchPluginSettingException if a plugin setting with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public com.liferay.portal.model.PluginSetting remove(long pluginSettingId)
069                    throws com.liferay.portal.NoSuchPluginSettingException,
070                            com.liferay.portal.kernel.exception.SystemException;
071    
072            public com.liferay.portal.model.PluginSetting updateImpl(
073                    com.liferay.portal.model.PluginSetting pluginSetting, boolean merge)
074                    throws com.liferay.portal.kernel.exception.SystemException;
075    
076            /**
077            * Finds the plugin setting with the primary key or throws a {@link com.liferay.portal.NoSuchPluginSettingException} if it could not be found.
078            *
079            * @param pluginSettingId the primary key of the plugin setting to find
080            * @return the plugin setting
081            * @throws com.liferay.portal.NoSuchPluginSettingException if a plugin setting with the primary key could not be found
082            * @throws SystemException if a system exception occurred
083            */
084            public com.liferay.portal.model.PluginSetting findByPrimaryKey(
085                    long pluginSettingId)
086                    throws com.liferay.portal.NoSuchPluginSettingException,
087                            com.liferay.portal.kernel.exception.SystemException;
088    
089            /**
090            * Finds the plugin setting with the primary key or returns <code>null</code> if it could not be found.
091            *
092            * @param pluginSettingId the primary key of the plugin setting to find
093            * @return the plugin setting, or <code>null</code> if a plugin setting with the primary key could not be found
094            * @throws SystemException if a system exception occurred
095            */
096            public com.liferay.portal.model.PluginSetting fetchByPrimaryKey(
097                    long pluginSettingId)
098                    throws com.liferay.portal.kernel.exception.SystemException;
099    
100            /**
101            * Finds all the plugin settings where companyId = &#63;.
102            *
103            * @param companyId the company id to search with
104            * @return the matching plugin settings
105            * @throws SystemException if a system exception occurred
106            */
107            public java.util.List<com.liferay.portal.model.PluginSetting> findByCompanyId(
108                    long companyId)
109                    throws com.liferay.portal.kernel.exception.SystemException;
110    
111            /**
112            * Finds a range of all the plugin settings where companyId = &#63;.
113            *
114            * <p>
115            * 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.
116            * </p>
117            *
118            * @param companyId the company id to search with
119            * @param start the lower bound of the range of plugin settings to return
120            * @param end the upper bound of the range of plugin settings to return (not inclusive)
121            * @return the range of matching plugin settings
122            * @throws SystemException if a system exception occurred
123            */
124            public java.util.List<com.liferay.portal.model.PluginSetting> findByCompanyId(
125                    long companyId, int start, int end)
126                    throws com.liferay.portal.kernel.exception.SystemException;
127    
128            /**
129            * Finds an ordered range of all the plugin settings where companyId = &#63;.
130            *
131            * <p>
132            * 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.
133            * </p>
134            *
135            * @param companyId the company id to search with
136            * @param start the lower bound of the range of plugin settings to return
137            * @param end the upper bound of the range of plugin settings to return (not inclusive)
138            * @param orderByComparator the comparator to order the results by
139            * @return the ordered range of matching plugin settings
140            * @throws SystemException if a system exception occurred
141            */
142            public java.util.List<com.liferay.portal.model.PluginSetting> findByCompanyId(
143                    long companyId, int start, int end,
144                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
145                    throws com.liferay.portal.kernel.exception.SystemException;
146    
147            /**
148            * Finds the first plugin setting in the ordered set where companyId = &#63;.
149            *
150            * <p>
151            * 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.
152            * </p>
153            *
154            * @param companyId the company id to search with
155            * @param orderByComparator the comparator to order the set by
156            * @return the first matching plugin setting
157            * @throws com.liferay.portal.NoSuchPluginSettingException if a matching plugin setting could not be found
158            * @throws SystemException if a system exception occurred
159            */
160            public com.liferay.portal.model.PluginSetting findByCompanyId_First(
161                    long companyId,
162                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
163                    throws com.liferay.portal.NoSuchPluginSettingException,
164                            com.liferay.portal.kernel.exception.SystemException;
165    
166            /**
167            * Finds the last plugin setting in the ordered set where companyId = &#63;.
168            *
169            * <p>
170            * 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.
171            * </p>
172            *
173            * @param companyId the company id to search with
174            * @param orderByComparator the comparator to order the set by
175            * @return the last matching plugin setting
176            * @throws com.liferay.portal.NoSuchPluginSettingException if a matching plugin setting could not be found
177            * @throws SystemException if a system exception occurred
178            */
179            public com.liferay.portal.model.PluginSetting findByCompanyId_Last(
180                    long companyId,
181                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
182                    throws com.liferay.portal.NoSuchPluginSettingException,
183                            com.liferay.portal.kernel.exception.SystemException;
184    
185            /**
186            * Finds the plugin settings before and after the current plugin setting in the ordered set where companyId = &#63;.
187            *
188            * <p>
189            * 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.
190            * </p>
191            *
192            * @param pluginSettingId the primary key of the current plugin setting
193            * @param companyId the company id to search with
194            * @param orderByComparator the comparator to order the set by
195            * @return the previous, current, and next plugin setting
196            * @throws com.liferay.portal.NoSuchPluginSettingException if a plugin setting with the primary key could not be found
197            * @throws SystemException if a system exception occurred
198            */
199            public com.liferay.portal.model.PluginSetting[] findByCompanyId_PrevAndNext(
200                    long pluginSettingId, long companyId,
201                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
202                    throws com.liferay.portal.NoSuchPluginSettingException,
203                            com.liferay.portal.kernel.exception.SystemException;
204    
205            /**
206            * 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.
207            *
208            * @param companyId the company id to search with
209            * @param pluginId the plugin id to search with
210            * @param pluginType the plugin type to search with
211            * @return the matching plugin setting
212            * @throws com.liferay.portal.NoSuchPluginSettingException if a matching plugin setting could not be found
213            * @throws SystemException if a system exception occurred
214            */
215            public com.liferay.portal.model.PluginSetting findByC_I_T(long companyId,
216                    java.lang.String pluginId, java.lang.String pluginType)
217                    throws com.liferay.portal.NoSuchPluginSettingException,
218                            com.liferay.portal.kernel.exception.SystemException;
219    
220            /**
221            * 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.
222            *
223            * @param companyId the company id to search with
224            * @param pluginId the plugin id to search with
225            * @param pluginType the plugin type to search with
226            * @return the matching plugin setting, or <code>null</code> if a matching plugin setting could not be found
227            * @throws SystemException if a system exception occurred
228            */
229            public com.liferay.portal.model.PluginSetting fetchByC_I_T(long companyId,
230                    java.lang.String pluginId, java.lang.String pluginType)
231                    throws com.liferay.portal.kernel.exception.SystemException;
232    
233            /**
234            * 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.
235            *
236            * @param companyId the company id to search with
237            * @param pluginId the plugin id to search with
238            * @param pluginType the plugin type to search with
239            * @return the matching plugin setting, or <code>null</code> if a matching plugin setting could not be found
240            * @throws SystemException if a system exception occurred
241            */
242            public com.liferay.portal.model.PluginSetting fetchByC_I_T(long companyId,
243                    java.lang.String pluginId, java.lang.String pluginType,
244                    boolean retrieveFromCache)
245                    throws com.liferay.portal.kernel.exception.SystemException;
246    
247            /**
248            * Finds all the plugin settings.
249            *
250            * @return the plugin settings
251            * @throws SystemException if a system exception occurred
252            */
253            public java.util.List<com.liferay.portal.model.PluginSetting> findAll()
254                    throws com.liferay.portal.kernel.exception.SystemException;
255    
256            /**
257            * Finds a range of all the plugin settings.
258            *
259            * <p>
260            * 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.
261            * </p>
262            *
263            * @param start the lower bound of the range of plugin settings to return
264            * @param end the upper bound of the range of plugin settings to return (not inclusive)
265            * @return the range of plugin settings
266            * @throws SystemException if a system exception occurred
267            */
268            public java.util.List<com.liferay.portal.model.PluginSetting> findAll(
269                    int start, int end)
270                    throws com.liferay.portal.kernel.exception.SystemException;
271    
272            /**
273            * Finds an ordered range of all the plugin settings.
274            *
275            * <p>
276            * 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.
277            * </p>
278            *
279            * @param start the lower bound of the range of plugin settings to return
280            * @param end the upper bound of the range of plugin settings to return (not inclusive)
281            * @param orderByComparator the comparator to order the results by
282            * @return the ordered 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                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
288                    throws com.liferay.portal.kernel.exception.SystemException;
289    
290            /**
291            * Removes all the plugin settings where companyId = &#63; from the database.
292            *
293            * @param companyId the company id to search with
294            * @throws SystemException if a system exception occurred
295            */
296            public void removeByCompanyId(long companyId)
297                    throws com.liferay.portal.kernel.exception.SystemException;
298    
299            /**
300            * Removes the plugin setting where companyId = &#63; and pluginId = &#63; and pluginType = &#63; from the database.
301            *
302            * @param companyId the company id to search with
303            * @param pluginId the plugin id to search with
304            * @param pluginType the plugin type to search with
305            * @throws SystemException if a system exception occurred
306            */
307            public void removeByC_I_T(long companyId, java.lang.String pluginId,
308                    java.lang.String pluginType)
309                    throws com.liferay.portal.NoSuchPluginSettingException,
310                            com.liferay.portal.kernel.exception.SystemException;
311    
312            /**
313            * Removes all the plugin settings from the database.
314            *
315            * @throws SystemException if a system exception occurred
316            */
317            public void removeAll()
318                    throws com.liferay.portal.kernel.exception.SystemException;
319    
320            /**
321            * Counts all the plugin settings where companyId = &#63;.
322            *
323            * @param companyId the company id to search with
324            * @return the number of matching plugin settings
325            * @throws SystemException if a system exception occurred
326            */
327            public int countByCompanyId(long companyId)
328                    throws com.liferay.portal.kernel.exception.SystemException;
329    
330            /**
331            * Counts all the plugin settings where companyId = &#63; and pluginId = &#63; and pluginType = &#63;.
332            *
333            * @param companyId the company id to search with
334            * @param pluginId the plugin id to search with
335            * @param pluginType the plugin type to search with
336            * @return the number of matching plugin settings
337            * @throws SystemException if a system exception occurred
338            */
339            public int countByC_I_T(long companyId, java.lang.String pluginId,
340                    java.lang.String pluginType)
341                    throws com.liferay.portal.kernel.exception.SystemException;
342    
343            /**
344            * Counts all the plugin settings.
345            *
346            * @return the number of plugin settings
347            * @throws SystemException if a system exception occurred
348            */
349            public int countAll()
350                    throws com.liferay.portal.kernel.exception.SystemException;
351    }