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