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