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