001 /** 002 * Copyright (c) 2000-2013 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.portlet.wiki.service.persistence; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.service.persistence.BasePersistence; 020 021 import com.liferay.portlet.wiki.model.WikiPageResource; 022 023 /** 024 * The persistence interface for the wiki page resource service. 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 WikiPageResourcePersistenceImpl 032 * @see WikiPageResourceUtil 033 * @generated 034 */ 035 @ProviderType 036 public interface WikiPageResourcePersistence extends BasePersistence<WikiPageResource> { 037 /* 038 * NOTE FOR DEVELOPERS: 039 * 040 * Never modify or reference this interface directly. Always use {@link WikiPageResourceUtil} to access the wiki page resource persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface. 041 */ 042 043 /** 044 * Returns all the wiki page resources where uuid = ?. 045 * 046 * @param uuid the uuid 047 * @return the matching wiki page resources 048 * @throws SystemException if a system exception occurred 049 */ 050 public java.util.List<com.liferay.portlet.wiki.model.WikiPageResource> findByUuid( 051 java.lang.String uuid) 052 throws com.liferay.portal.kernel.exception.SystemException; 053 054 /** 055 * Returns a range of all the wiki page resources where uuid = ?. 056 * 057 * <p> 058 * 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.portlet.wiki.model.impl.WikiPageResourceModelImpl}. 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. 059 * </p> 060 * 061 * @param uuid the uuid 062 * @param start the lower bound of the range of wiki page resources 063 * @param end the upper bound of the range of wiki page resources (not inclusive) 064 * @return the range of matching wiki page resources 065 * @throws SystemException if a system exception occurred 066 */ 067 public java.util.List<com.liferay.portlet.wiki.model.WikiPageResource> findByUuid( 068 java.lang.String uuid, int start, int end) 069 throws com.liferay.portal.kernel.exception.SystemException; 070 071 /** 072 * Returns an ordered range of all the wiki page resources where uuid = ?. 073 * 074 * <p> 075 * 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.portlet.wiki.model.impl.WikiPageResourceModelImpl}. 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. 076 * </p> 077 * 078 * @param uuid the uuid 079 * @param start the lower bound of the range of wiki page resources 080 * @param end the upper bound of the range of wiki page resources (not inclusive) 081 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 082 * @return the ordered range of matching wiki page resources 083 * @throws SystemException if a system exception occurred 084 */ 085 public java.util.List<com.liferay.portlet.wiki.model.WikiPageResource> findByUuid( 086 java.lang.String uuid, int start, int end, 087 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 088 throws com.liferay.portal.kernel.exception.SystemException; 089 090 /** 091 * Returns the first wiki page resource in the ordered set where uuid = ?. 092 * 093 * @param uuid the uuid 094 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 095 * @return the first matching wiki page resource 096 * @throws com.liferay.portlet.wiki.NoSuchPageResourceException if a matching wiki page resource could not be found 097 * @throws SystemException if a system exception occurred 098 */ 099 public com.liferay.portlet.wiki.model.WikiPageResource findByUuid_First( 100 java.lang.String uuid, 101 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 102 throws com.liferay.portal.kernel.exception.SystemException, 103 com.liferay.portlet.wiki.NoSuchPageResourceException; 104 105 /** 106 * Returns the first wiki page resource in the ordered set where uuid = ?. 107 * 108 * @param uuid the uuid 109 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 110 * @return the first matching wiki page resource, or <code>null</code> if a matching wiki page resource could not be found 111 * @throws SystemException if a system exception occurred 112 */ 113 public com.liferay.portlet.wiki.model.WikiPageResource fetchByUuid_First( 114 java.lang.String uuid, 115 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 116 throws com.liferay.portal.kernel.exception.SystemException; 117 118 /** 119 * Returns the last wiki page resource in the ordered set where uuid = ?. 120 * 121 * @param uuid the uuid 122 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 123 * @return the last matching wiki page resource 124 * @throws com.liferay.portlet.wiki.NoSuchPageResourceException if a matching wiki page resource could not be found 125 * @throws SystemException if a system exception occurred 126 */ 127 public com.liferay.portlet.wiki.model.WikiPageResource findByUuid_Last( 128 java.lang.String uuid, 129 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 130 throws com.liferay.portal.kernel.exception.SystemException, 131 com.liferay.portlet.wiki.NoSuchPageResourceException; 132 133 /** 134 * Returns the last wiki page resource in the ordered set where uuid = ?. 135 * 136 * @param uuid the uuid 137 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 138 * @return the last matching wiki page resource, or <code>null</code> if a matching wiki page resource could not be found 139 * @throws SystemException if a system exception occurred 140 */ 141 public com.liferay.portlet.wiki.model.WikiPageResource fetchByUuid_Last( 142 java.lang.String uuid, 143 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 144 throws com.liferay.portal.kernel.exception.SystemException; 145 146 /** 147 * Returns the wiki page resources before and after the current wiki page resource in the ordered set where uuid = ?. 148 * 149 * @param resourcePrimKey the primary key of the current wiki page resource 150 * @param uuid the uuid 151 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 152 * @return the previous, current, and next wiki page resource 153 * @throws com.liferay.portlet.wiki.NoSuchPageResourceException if a wiki page resource with the primary key could not be found 154 * @throws SystemException if a system exception occurred 155 */ 156 public com.liferay.portlet.wiki.model.WikiPageResource[] findByUuid_PrevAndNext( 157 long resourcePrimKey, java.lang.String uuid, 158 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 159 throws com.liferay.portal.kernel.exception.SystemException, 160 com.liferay.portlet.wiki.NoSuchPageResourceException; 161 162 /** 163 * Removes all the wiki page resources where uuid = ? from the database. 164 * 165 * @param uuid the uuid 166 * @throws SystemException if a system exception occurred 167 */ 168 public void removeByUuid(java.lang.String uuid) 169 throws com.liferay.portal.kernel.exception.SystemException; 170 171 /** 172 * Returns the number of wiki page resources where uuid = ?. 173 * 174 * @param uuid the uuid 175 * @return the number of matching wiki page resources 176 * @throws SystemException if a system exception occurred 177 */ 178 public int countByUuid(java.lang.String uuid) 179 throws com.liferay.portal.kernel.exception.SystemException; 180 181 /** 182 * Returns the wiki page resource where nodeId = ? and title = ? or throws a {@link com.liferay.portlet.wiki.NoSuchPageResourceException} if it could not be found. 183 * 184 * @param nodeId the node ID 185 * @param title the title 186 * @return the matching wiki page resource 187 * @throws com.liferay.portlet.wiki.NoSuchPageResourceException if a matching wiki page resource could not be found 188 * @throws SystemException if a system exception occurred 189 */ 190 public com.liferay.portlet.wiki.model.WikiPageResource findByN_T( 191 long nodeId, java.lang.String title) 192 throws com.liferay.portal.kernel.exception.SystemException, 193 com.liferay.portlet.wiki.NoSuchPageResourceException; 194 195 /** 196 * Returns the wiki page resource where nodeId = ? and title = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 197 * 198 * @param nodeId the node ID 199 * @param title the title 200 * @return the matching wiki page resource, or <code>null</code> if a matching wiki page resource could not be found 201 * @throws SystemException if a system exception occurred 202 */ 203 public com.liferay.portlet.wiki.model.WikiPageResource fetchByN_T( 204 long nodeId, java.lang.String title) 205 throws com.liferay.portal.kernel.exception.SystemException; 206 207 /** 208 * Returns the wiki page resource where nodeId = ? and title = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 209 * 210 * @param nodeId the node ID 211 * @param title the title 212 * @param retrieveFromCache whether to use the finder cache 213 * @return the matching wiki page resource, or <code>null</code> if a matching wiki page resource could not be found 214 * @throws SystemException if a system exception occurred 215 */ 216 public com.liferay.portlet.wiki.model.WikiPageResource fetchByN_T( 217 long nodeId, java.lang.String title, boolean retrieveFromCache) 218 throws com.liferay.portal.kernel.exception.SystemException; 219 220 /** 221 * Removes the wiki page resource where nodeId = ? and title = ? from the database. 222 * 223 * @param nodeId the node ID 224 * @param title the title 225 * @return the wiki page resource that was removed 226 * @throws SystemException if a system exception occurred 227 */ 228 public com.liferay.portlet.wiki.model.WikiPageResource removeByN_T( 229 long nodeId, java.lang.String title) 230 throws com.liferay.portal.kernel.exception.SystemException, 231 com.liferay.portlet.wiki.NoSuchPageResourceException; 232 233 /** 234 * Returns the number of wiki page resources where nodeId = ? and title = ?. 235 * 236 * @param nodeId the node ID 237 * @param title the title 238 * @return the number of matching wiki page resources 239 * @throws SystemException if a system exception occurred 240 */ 241 public int countByN_T(long nodeId, java.lang.String title) 242 throws com.liferay.portal.kernel.exception.SystemException; 243 244 /** 245 * Caches the wiki page resource in the entity cache if it is enabled. 246 * 247 * @param wikiPageResource the wiki page resource 248 */ 249 public void cacheResult( 250 com.liferay.portlet.wiki.model.WikiPageResource wikiPageResource); 251 252 /** 253 * Caches the wiki page resources in the entity cache if it is enabled. 254 * 255 * @param wikiPageResources the wiki page resources 256 */ 257 public void cacheResult( 258 java.util.List<com.liferay.portlet.wiki.model.WikiPageResource> wikiPageResources); 259 260 /** 261 * Creates a new wiki page resource with the primary key. Does not add the wiki page resource to the database. 262 * 263 * @param resourcePrimKey the primary key for the new wiki page resource 264 * @return the new wiki page resource 265 */ 266 public com.liferay.portlet.wiki.model.WikiPageResource create( 267 long resourcePrimKey); 268 269 /** 270 * Removes the wiki page resource with the primary key from the database. Also notifies the appropriate model listeners. 271 * 272 * @param resourcePrimKey the primary key of the wiki page resource 273 * @return the wiki page resource that was removed 274 * @throws com.liferay.portlet.wiki.NoSuchPageResourceException if a wiki page resource with the primary key could not be found 275 * @throws SystemException if a system exception occurred 276 */ 277 public com.liferay.portlet.wiki.model.WikiPageResource remove( 278 long resourcePrimKey) 279 throws com.liferay.portal.kernel.exception.SystemException, 280 com.liferay.portlet.wiki.NoSuchPageResourceException; 281 282 public com.liferay.portlet.wiki.model.WikiPageResource updateImpl( 283 com.liferay.portlet.wiki.model.WikiPageResource wikiPageResource) 284 throws com.liferay.portal.kernel.exception.SystemException; 285 286 /** 287 * Returns the wiki page resource with the primary key or throws a {@link com.liferay.portlet.wiki.NoSuchPageResourceException} if it could not be found. 288 * 289 * @param resourcePrimKey the primary key of the wiki page resource 290 * @return the wiki page resource 291 * @throws com.liferay.portlet.wiki.NoSuchPageResourceException if a wiki page resource with the primary key could not be found 292 * @throws SystemException if a system exception occurred 293 */ 294 public com.liferay.portlet.wiki.model.WikiPageResource findByPrimaryKey( 295 long resourcePrimKey) 296 throws com.liferay.portal.kernel.exception.SystemException, 297 com.liferay.portlet.wiki.NoSuchPageResourceException; 298 299 /** 300 * Returns the wiki page resource with the primary key or returns <code>null</code> if it could not be found. 301 * 302 * @param resourcePrimKey the primary key of the wiki page resource 303 * @return the wiki page resource, or <code>null</code> if a wiki page resource with the primary key could not be found 304 * @throws SystemException if a system exception occurred 305 */ 306 public com.liferay.portlet.wiki.model.WikiPageResource fetchByPrimaryKey( 307 long resourcePrimKey) 308 throws com.liferay.portal.kernel.exception.SystemException; 309 310 /** 311 * Returns all the wiki page resources. 312 * 313 * @return the wiki page resources 314 * @throws SystemException if a system exception occurred 315 */ 316 public java.util.List<com.liferay.portlet.wiki.model.WikiPageResource> findAll() 317 throws com.liferay.portal.kernel.exception.SystemException; 318 319 /** 320 * Returns a range of all the wiki page resources. 321 * 322 * <p> 323 * 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.portlet.wiki.model.impl.WikiPageResourceModelImpl}. 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. 324 * </p> 325 * 326 * @param start the lower bound of the range of wiki page resources 327 * @param end the upper bound of the range of wiki page resources (not inclusive) 328 * @return the range of wiki page resources 329 * @throws SystemException if a system exception occurred 330 */ 331 public java.util.List<com.liferay.portlet.wiki.model.WikiPageResource> findAll( 332 int start, int end) 333 throws com.liferay.portal.kernel.exception.SystemException; 334 335 /** 336 * Returns an ordered range of all the wiki page resources. 337 * 338 * <p> 339 * 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.portlet.wiki.model.impl.WikiPageResourceModelImpl}. 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. 340 * </p> 341 * 342 * @param start the lower bound of the range of wiki page resources 343 * @param end the upper bound of the range of wiki page resources (not inclusive) 344 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 345 * @return the ordered range of wiki page resources 346 * @throws SystemException if a system exception occurred 347 */ 348 public java.util.List<com.liferay.portlet.wiki.model.WikiPageResource> findAll( 349 int start, int end, 350 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 351 throws com.liferay.portal.kernel.exception.SystemException; 352 353 /** 354 * Removes all the wiki page resources from the database. 355 * 356 * @throws SystemException if a system exception occurred 357 */ 358 public void removeAll() 359 throws com.liferay.portal.kernel.exception.SystemException; 360 361 /** 362 * Returns the number of wiki page resources. 363 * 364 * @return the number of wiki page resources 365 * @throws SystemException if a system exception occurred 366 */ 367 public int countAll() 368 throws com.liferay.portal.kernel.exception.SystemException; 369 }