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