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