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