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.model.PluginSetting; 020 021 /** 022 * The persistence interface for the plugin setting service. 023 * 024 * <p> 025 * Caching information and settings can be found in <code>portal.properties</code> 026 * </p> 027 * 028 * @author Brian Wing Shun Chan 029 * @see com.liferay.portal.service.persistence.impl.PluginSettingPersistenceImpl 030 * @see PluginSettingUtil 031 * @generated 032 */ 033 @ProviderType 034 public interface PluginSettingPersistence extends BasePersistence<PluginSetting> { 035 /* 036 * NOTE FOR DEVELOPERS: 037 * 038 * 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. 039 */ 040 041 /** 042 * Returns all the plugin settings where companyId = ?. 043 * 044 * @param companyId the company ID 045 * @return the matching plugin settings 046 */ 047 public java.util.List<PluginSetting> findByCompanyId(long companyId); 048 049 /** 050 * Returns a range of all the plugin settings where companyId = ?. 051 * 052 * <p> 053 * 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. 054 * </p> 055 * 056 * @param companyId the company ID 057 * @param start the lower bound of the range of plugin settings 058 * @param end the upper bound of the range of plugin settings (not inclusive) 059 * @return the range of matching plugin settings 060 */ 061 public java.util.List<PluginSetting> findByCompanyId(long companyId, 062 int start, int end); 063 064 /** 065 * Returns an ordered range of all the plugin settings where companyId = ?. 066 * 067 * <p> 068 * 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. 069 * </p> 070 * 071 * @param companyId the company ID 072 * @param start the lower bound of the range of plugin settings 073 * @param end the upper bound of the range of plugin settings (not inclusive) 074 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 075 * @return the ordered range of matching plugin settings 076 */ 077 public java.util.List<PluginSetting> findByCompanyId(long companyId, 078 int start, int end, 079 com.liferay.portal.kernel.util.OrderByComparator<PluginSetting> orderByComparator); 080 081 /** 082 * Returns an ordered range of all the plugin settings where companyId = ?. 083 * 084 * <p> 085 * 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. 086 * </p> 087 * 088 * @param companyId the company ID 089 * @param start the lower bound of the range of plugin settings 090 * @param end the upper bound of the range of plugin settings (not inclusive) 091 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 092 * @param retrieveFromCache whether to retrieve from the finder cache 093 * @return the ordered range of matching plugin settings 094 */ 095 public java.util.List<PluginSetting> findByCompanyId(long companyId, 096 int start, int end, 097 com.liferay.portal.kernel.util.OrderByComparator<PluginSetting> orderByComparator, 098 boolean retrieveFromCache); 099 100 /** 101 * Returns the first plugin setting in the ordered set where companyId = ?. 102 * 103 * @param companyId the company ID 104 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 105 * @return the first matching plugin setting 106 * @throws NoSuchPluginSettingException if a matching plugin setting could not be found 107 */ 108 public PluginSetting findByCompanyId_First(long companyId, 109 com.liferay.portal.kernel.util.OrderByComparator<PluginSetting> orderByComparator) 110 throws com.liferay.portal.exception.NoSuchPluginSettingException; 111 112 /** 113 * Returns the first plugin setting in the ordered set where companyId = ?. 114 * 115 * @param companyId the company ID 116 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 117 * @return the first matching plugin setting, or <code>null</code> if a matching plugin setting could not be found 118 */ 119 public PluginSetting fetchByCompanyId_First(long companyId, 120 com.liferay.portal.kernel.util.OrderByComparator<PluginSetting> orderByComparator); 121 122 /** 123 * Returns the last plugin setting in the ordered set where companyId = ?. 124 * 125 * @param companyId the company ID 126 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 127 * @return the last matching plugin setting 128 * @throws NoSuchPluginSettingException if a matching plugin setting could not be found 129 */ 130 public PluginSetting findByCompanyId_Last(long companyId, 131 com.liferay.portal.kernel.util.OrderByComparator<PluginSetting> orderByComparator) 132 throws com.liferay.portal.exception.NoSuchPluginSettingException; 133 134 /** 135 * Returns the last plugin setting in the ordered set where companyId = ?. 136 * 137 * @param companyId the company ID 138 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 139 * @return the last matching plugin setting, or <code>null</code> if a matching plugin setting could not be found 140 */ 141 public PluginSetting fetchByCompanyId_Last(long companyId, 142 com.liferay.portal.kernel.util.OrderByComparator<PluginSetting> orderByComparator); 143 144 /** 145 * Returns the plugin settings before and after the current plugin setting in the ordered set where companyId = ?. 146 * 147 * @param pluginSettingId the primary key of the current plugin setting 148 * @param companyId the company ID 149 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 150 * @return the previous, current, and next plugin setting 151 * @throws NoSuchPluginSettingException if a plugin setting with the primary key could not be found 152 */ 153 public PluginSetting[] findByCompanyId_PrevAndNext(long pluginSettingId, 154 long companyId, 155 com.liferay.portal.kernel.util.OrderByComparator<PluginSetting> orderByComparator) 156 throws com.liferay.portal.exception.NoSuchPluginSettingException; 157 158 /** 159 * Removes all the plugin settings where companyId = ? from the database. 160 * 161 * @param companyId the company ID 162 */ 163 public void removeByCompanyId(long companyId); 164 165 /** 166 * Returns the number of plugin settings where companyId = ?. 167 * 168 * @param companyId the company ID 169 * @return the number of matching plugin settings 170 */ 171 public int countByCompanyId(long companyId); 172 173 /** 174 * Returns the plugin setting where companyId = ? and pluginId = ? and pluginType = ? or throws a {@link NoSuchPluginSettingException} if it could not be found. 175 * 176 * @param companyId the company ID 177 * @param pluginId the plugin ID 178 * @param pluginType the plugin type 179 * @return the matching plugin setting 180 * @throws NoSuchPluginSettingException if a matching plugin setting could not be found 181 */ 182 public PluginSetting findByC_I_T(long companyId, java.lang.String pluginId, 183 java.lang.String pluginType) 184 throws com.liferay.portal.exception.NoSuchPluginSettingException; 185 186 /** 187 * Returns the plugin setting where companyId = ? and pluginId = ? and pluginType = ? 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 = ? and pluginId = ? and pluginType = ? 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 = ? and pluginId = ? and pluginType = ? 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 com.liferay.portal.exception.NoSuchPluginSettingException; 221 222 /** 223 * Returns the number of plugin settings where companyId = ? and pluginId = ? and pluginType = ?. 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 com.liferay.portal.exception.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 com.liferay.portal.exception.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 }