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.LayoutSet; 020 021 /** 022 * The persistence interface for the layout set 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 LayoutSetPersistenceImpl 030 * @see LayoutSetUtil 031 * @generated 032 */ 033 @ProviderType 034 public interface LayoutSetPersistence extends BasePersistence<LayoutSet> { 035 /* 036 * NOTE FOR DEVELOPERS: 037 * 038 * Never modify or reference this interface directly. Always use {@link LayoutSetUtil} to access the layout set persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface. 039 */ 040 041 /** 042 * Returns all the layout sets where groupId = ?. 043 * 044 * @param groupId the group ID 045 * @return the matching layout sets 046 */ 047 public java.util.List<com.liferay.portal.model.LayoutSet> findByGroupId( 048 long groupId); 049 050 /** 051 * Returns a range of all the layout sets where groupId = ?. 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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutSetModelImpl}. 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 groupId the group ID 058 * @param start the lower bound of the range of layout sets 059 * @param end the upper bound of the range of layout sets (not inclusive) 060 * @return the range of matching layout sets 061 */ 062 public java.util.List<com.liferay.portal.model.LayoutSet> findByGroupId( 063 long groupId, int start, int end); 064 065 /** 066 * Returns an ordered range of all the layout sets where groupId = ?. 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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutSetModelImpl}. 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 groupId the group ID 073 * @param start the lower bound of the range of layout sets 074 * @param end the upper bound of the range of layout sets (not inclusive) 075 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 076 * @return the ordered range of matching layout sets 077 */ 078 public java.util.List<com.liferay.portal.model.LayoutSet> findByGroupId( 079 long groupId, int start, int end, 080 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.LayoutSet> orderByComparator); 081 082 /** 083 * Returns the first layout set in the ordered set where groupId = ?. 084 * 085 * @param groupId the group ID 086 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 087 * @return the first matching layout set 088 * @throws com.liferay.portal.NoSuchLayoutSetException if a matching layout set could not be found 089 */ 090 public com.liferay.portal.model.LayoutSet findByGroupId_First( 091 long groupId, 092 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.LayoutSet> orderByComparator) 093 throws com.liferay.portal.NoSuchLayoutSetException; 094 095 /** 096 * Returns the first layout set in the ordered set where groupId = ?. 097 * 098 * @param groupId the group ID 099 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 100 * @return the first matching layout set, or <code>null</code> if a matching layout set could not be found 101 */ 102 public com.liferay.portal.model.LayoutSet fetchByGroupId_First( 103 long groupId, 104 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.LayoutSet> orderByComparator); 105 106 /** 107 * Returns the last layout set in the ordered set where groupId = ?. 108 * 109 * @param groupId the group ID 110 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 111 * @return the last matching layout set 112 * @throws com.liferay.portal.NoSuchLayoutSetException if a matching layout set could not be found 113 */ 114 public com.liferay.portal.model.LayoutSet findByGroupId_Last(long groupId, 115 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.LayoutSet> orderByComparator) 116 throws com.liferay.portal.NoSuchLayoutSetException; 117 118 /** 119 * Returns the last layout set in the ordered set where groupId = ?. 120 * 121 * @param groupId the group ID 122 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 123 * @return the last matching layout set, or <code>null</code> if a matching layout set could not be found 124 */ 125 public com.liferay.portal.model.LayoutSet fetchByGroupId_Last( 126 long groupId, 127 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.LayoutSet> orderByComparator); 128 129 /** 130 * Returns the layout sets before and after the current layout set in the ordered set where groupId = ?. 131 * 132 * @param layoutSetId the primary key of the current layout set 133 * @param groupId the group ID 134 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 135 * @return the previous, current, and next layout set 136 * @throws com.liferay.portal.NoSuchLayoutSetException if a layout set with the primary key could not be found 137 */ 138 public com.liferay.portal.model.LayoutSet[] findByGroupId_PrevAndNext( 139 long layoutSetId, long groupId, 140 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.LayoutSet> orderByComparator) 141 throws com.liferay.portal.NoSuchLayoutSetException; 142 143 /** 144 * Removes all the layout sets where groupId = ? from the database. 145 * 146 * @param groupId the group ID 147 */ 148 public void removeByGroupId(long groupId); 149 150 /** 151 * Returns the number of layout sets where groupId = ?. 152 * 153 * @param groupId the group ID 154 * @return the number of matching layout sets 155 */ 156 public int countByGroupId(long groupId); 157 158 /** 159 * Returns all the layout sets where layoutSetPrototypeUuid = ?. 160 * 161 * @param layoutSetPrototypeUuid the layout set prototype uuid 162 * @return the matching layout sets 163 */ 164 public java.util.List<com.liferay.portal.model.LayoutSet> findByLayoutSetPrototypeUuid( 165 java.lang.String layoutSetPrototypeUuid); 166 167 /** 168 * Returns a range of all the layout sets where layoutSetPrototypeUuid = ?. 169 * 170 * <p> 171 * 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. 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutSetModelImpl}. 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. 172 * </p> 173 * 174 * @param layoutSetPrototypeUuid the layout set prototype uuid 175 * @param start the lower bound of the range of layout sets 176 * @param end the upper bound of the range of layout sets (not inclusive) 177 * @return the range of matching layout sets 178 */ 179 public java.util.List<com.liferay.portal.model.LayoutSet> findByLayoutSetPrototypeUuid( 180 java.lang.String layoutSetPrototypeUuid, int start, int end); 181 182 /** 183 * Returns an ordered range of all the layout sets where layoutSetPrototypeUuid = ?. 184 * 185 * <p> 186 * 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. 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutSetModelImpl}. 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. 187 * </p> 188 * 189 * @param layoutSetPrototypeUuid the layout set prototype uuid 190 * @param start the lower bound of the range of layout sets 191 * @param end the upper bound of the range of layout sets (not inclusive) 192 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 193 * @return the ordered range of matching layout sets 194 */ 195 public java.util.List<com.liferay.portal.model.LayoutSet> findByLayoutSetPrototypeUuid( 196 java.lang.String layoutSetPrototypeUuid, int start, int end, 197 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.LayoutSet> orderByComparator); 198 199 /** 200 * Returns the first layout set in the ordered set where layoutSetPrototypeUuid = ?. 201 * 202 * @param layoutSetPrototypeUuid the layout set prototype uuid 203 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 204 * @return the first matching layout set 205 * @throws com.liferay.portal.NoSuchLayoutSetException if a matching layout set could not be found 206 */ 207 public com.liferay.portal.model.LayoutSet findByLayoutSetPrototypeUuid_First( 208 java.lang.String layoutSetPrototypeUuid, 209 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.LayoutSet> orderByComparator) 210 throws com.liferay.portal.NoSuchLayoutSetException; 211 212 /** 213 * Returns the first layout set in the ordered set where layoutSetPrototypeUuid = ?. 214 * 215 * @param layoutSetPrototypeUuid the layout set prototype uuid 216 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 217 * @return the first matching layout set, or <code>null</code> if a matching layout set could not be found 218 */ 219 public com.liferay.portal.model.LayoutSet fetchByLayoutSetPrototypeUuid_First( 220 java.lang.String layoutSetPrototypeUuid, 221 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.LayoutSet> orderByComparator); 222 223 /** 224 * Returns the last layout set in the ordered set where layoutSetPrototypeUuid = ?. 225 * 226 * @param layoutSetPrototypeUuid the layout set prototype uuid 227 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 228 * @return the last matching layout set 229 * @throws com.liferay.portal.NoSuchLayoutSetException if a matching layout set could not be found 230 */ 231 public com.liferay.portal.model.LayoutSet findByLayoutSetPrototypeUuid_Last( 232 java.lang.String layoutSetPrototypeUuid, 233 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.LayoutSet> orderByComparator) 234 throws com.liferay.portal.NoSuchLayoutSetException; 235 236 /** 237 * Returns the last layout set in the ordered set where layoutSetPrototypeUuid = ?. 238 * 239 * @param layoutSetPrototypeUuid the layout set prototype uuid 240 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 241 * @return the last matching layout set, or <code>null</code> if a matching layout set could not be found 242 */ 243 public com.liferay.portal.model.LayoutSet fetchByLayoutSetPrototypeUuid_Last( 244 java.lang.String layoutSetPrototypeUuid, 245 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.LayoutSet> orderByComparator); 246 247 /** 248 * Returns the layout sets before and after the current layout set in the ordered set where layoutSetPrototypeUuid = ?. 249 * 250 * @param layoutSetId the primary key of the current layout set 251 * @param layoutSetPrototypeUuid the layout set prototype uuid 252 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 253 * @return the previous, current, and next layout set 254 * @throws com.liferay.portal.NoSuchLayoutSetException if a layout set with the primary key could not be found 255 */ 256 public com.liferay.portal.model.LayoutSet[] findByLayoutSetPrototypeUuid_PrevAndNext( 257 long layoutSetId, java.lang.String layoutSetPrototypeUuid, 258 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.LayoutSet> orderByComparator) 259 throws com.liferay.portal.NoSuchLayoutSetException; 260 261 /** 262 * Removes all the layout sets where layoutSetPrototypeUuid = ? from the database. 263 * 264 * @param layoutSetPrototypeUuid the layout set prototype uuid 265 */ 266 public void removeByLayoutSetPrototypeUuid( 267 java.lang.String layoutSetPrototypeUuid); 268 269 /** 270 * Returns the number of layout sets where layoutSetPrototypeUuid = ?. 271 * 272 * @param layoutSetPrototypeUuid the layout set prototype uuid 273 * @return the number of matching layout sets 274 */ 275 public int countByLayoutSetPrototypeUuid( 276 java.lang.String layoutSetPrototypeUuid); 277 278 /** 279 * Returns the layout set where groupId = ? and privateLayout = ? or throws a {@link com.liferay.portal.NoSuchLayoutSetException} if it could not be found. 280 * 281 * @param groupId the group ID 282 * @param privateLayout the private layout 283 * @return the matching layout set 284 * @throws com.liferay.portal.NoSuchLayoutSetException if a matching layout set could not be found 285 */ 286 public com.liferay.portal.model.LayoutSet findByG_P(long groupId, 287 boolean privateLayout) 288 throws com.liferay.portal.NoSuchLayoutSetException; 289 290 /** 291 * Returns the layout set where groupId = ? and privateLayout = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 292 * 293 * @param groupId the group ID 294 * @param privateLayout the private layout 295 * @return the matching layout set, or <code>null</code> if a matching layout set could not be found 296 */ 297 public com.liferay.portal.model.LayoutSet fetchByG_P(long groupId, 298 boolean privateLayout); 299 300 /** 301 * Returns the layout set where groupId = ? and privateLayout = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 302 * 303 * @param groupId the group ID 304 * @param privateLayout the private layout 305 * @param retrieveFromCache whether to use the finder cache 306 * @return the matching layout set, or <code>null</code> if a matching layout set could not be found 307 */ 308 public com.liferay.portal.model.LayoutSet fetchByG_P(long groupId, 309 boolean privateLayout, boolean retrieveFromCache); 310 311 /** 312 * Removes the layout set where groupId = ? and privateLayout = ? from the database. 313 * 314 * @param groupId the group ID 315 * @param privateLayout the private layout 316 * @return the layout set that was removed 317 */ 318 public com.liferay.portal.model.LayoutSet removeByG_P(long groupId, 319 boolean privateLayout) 320 throws com.liferay.portal.NoSuchLayoutSetException; 321 322 /** 323 * Returns the number of layout sets where groupId = ? and privateLayout = ?. 324 * 325 * @param groupId the group ID 326 * @param privateLayout the private layout 327 * @return the number of matching layout sets 328 */ 329 public int countByG_P(long groupId, boolean privateLayout); 330 331 /** 332 * Caches the layout set in the entity cache if it is enabled. 333 * 334 * @param layoutSet the layout set 335 */ 336 public void cacheResult(com.liferay.portal.model.LayoutSet layoutSet); 337 338 /** 339 * Caches the layout sets in the entity cache if it is enabled. 340 * 341 * @param layoutSets the layout sets 342 */ 343 public void cacheResult( 344 java.util.List<com.liferay.portal.model.LayoutSet> layoutSets); 345 346 /** 347 * Creates a new layout set with the primary key. Does not add the layout set to the database. 348 * 349 * @param layoutSetId the primary key for the new layout set 350 * @return the new layout set 351 */ 352 public com.liferay.portal.model.LayoutSet create(long layoutSetId); 353 354 /** 355 * Removes the layout set with the primary key from the database. Also notifies the appropriate model listeners. 356 * 357 * @param layoutSetId the primary key of the layout set 358 * @return the layout set that was removed 359 * @throws com.liferay.portal.NoSuchLayoutSetException if a layout set with the primary key could not be found 360 */ 361 public com.liferay.portal.model.LayoutSet remove(long layoutSetId) 362 throws com.liferay.portal.NoSuchLayoutSetException; 363 364 public com.liferay.portal.model.LayoutSet updateImpl( 365 com.liferay.portal.model.LayoutSet layoutSet); 366 367 /** 368 * Returns the layout set with the primary key or throws a {@link com.liferay.portal.NoSuchLayoutSetException} if it could not be found. 369 * 370 * @param layoutSetId the primary key of the layout set 371 * @return the layout set 372 * @throws com.liferay.portal.NoSuchLayoutSetException if a layout set with the primary key could not be found 373 */ 374 public com.liferay.portal.model.LayoutSet findByPrimaryKey(long layoutSetId) 375 throws com.liferay.portal.NoSuchLayoutSetException; 376 377 /** 378 * Returns the layout set with the primary key or returns <code>null</code> if it could not be found. 379 * 380 * @param layoutSetId the primary key of the layout set 381 * @return the layout set, or <code>null</code> if a layout set with the primary key could not be found 382 */ 383 public com.liferay.portal.model.LayoutSet fetchByPrimaryKey( 384 long layoutSetId); 385 386 @Override 387 public java.util.Map<java.io.Serializable, com.liferay.portal.model.LayoutSet> fetchByPrimaryKeys( 388 java.util.Set<java.io.Serializable> primaryKeys); 389 390 /** 391 * Returns all the layout sets. 392 * 393 * @return the layout sets 394 */ 395 public java.util.List<com.liferay.portal.model.LayoutSet> findAll(); 396 397 /** 398 * Returns a range of all the layout sets. 399 * 400 * <p> 401 * 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. 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutSetModelImpl}. 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. 402 * </p> 403 * 404 * @param start the lower bound of the range of layout sets 405 * @param end the upper bound of the range of layout sets (not inclusive) 406 * @return the range of layout sets 407 */ 408 public java.util.List<com.liferay.portal.model.LayoutSet> findAll( 409 int start, int end); 410 411 /** 412 * Returns an ordered range of all the layout sets. 413 * 414 * <p> 415 * 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. 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutSetModelImpl}. 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. 416 * </p> 417 * 418 * @param start the lower bound of the range of layout sets 419 * @param end the upper bound of the range of layout sets (not inclusive) 420 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 421 * @return the ordered range of layout sets 422 */ 423 public java.util.List<com.liferay.portal.model.LayoutSet> findAll( 424 int start, int end, 425 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.LayoutSet> orderByComparator); 426 427 /** 428 * Removes all the layout sets from the database. 429 */ 430 public void removeAll(); 431 432 /** 433 * Returns the number of layout sets. 434 * 435 * @return the number of layout sets 436 */ 437 public int countAll(); 438 }