001 /** 002 * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 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.SocialEquityGroupSetting; 020 021 /** 022 * The persistence interface for the social equity group setting service. 023 * 024 * <p> 025 * Never modify or reference this interface directly. Always use {@link SocialEquityGroupSettingUtil} to access the social equity group 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 SocialEquityGroupSettingPersistenceImpl 034 * @see SocialEquityGroupSettingUtil 035 * @generated 036 */ 037 public interface SocialEquityGroupSettingPersistence extends BasePersistence<SocialEquityGroupSetting> { 038 /** 039 * Caches the social equity group setting in the entity cache if it is enabled. 040 * 041 * @param socialEquityGroupSetting the social equity group setting to cache 042 */ 043 public void cacheResult( 044 com.liferay.portlet.social.model.SocialEquityGroupSetting socialEquityGroupSetting); 045 046 /** 047 * Caches the social equity group settings in the entity cache if it is enabled. 048 * 049 * @param socialEquityGroupSettings the social equity group settings to cache 050 */ 051 public void cacheResult( 052 java.util.List<com.liferay.portlet.social.model.SocialEquityGroupSetting> socialEquityGroupSettings); 053 054 /** 055 * Creates a new social equity group setting with the primary key. Does not add the social equity group setting to the database. 056 * 057 * @param equityGroupSettingId the primary key for the new social equity group setting 058 * @return the new social equity group setting 059 */ 060 public com.liferay.portlet.social.model.SocialEquityGroupSetting create( 061 long equityGroupSettingId); 062 063 /** 064 * Removes the social equity group setting with the primary key from the database. Also notifies the appropriate model listeners. 065 * 066 * @param equityGroupSettingId the primary key of the social equity group setting to remove 067 * @return the social equity group setting that was removed 068 * @throws com.liferay.portlet.social.NoSuchEquityGroupSettingException if a social equity group 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.SocialEquityGroupSetting remove( 072 long equityGroupSettingId) 073 throws com.liferay.portal.kernel.exception.SystemException, 074 com.liferay.portlet.social.NoSuchEquityGroupSettingException; 075 076 public com.liferay.portlet.social.model.SocialEquityGroupSetting updateImpl( 077 com.liferay.portlet.social.model.SocialEquityGroupSetting socialEquityGroupSetting, 078 boolean merge) 079 throws com.liferay.portal.kernel.exception.SystemException; 080 081 /** 082 * Finds the social equity group setting with the primary key or throws a {@link com.liferay.portlet.social.NoSuchEquityGroupSettingException} if it could not be found. 083 * 084 * @param equityGroupSettingId the primary key of the social equity group setting to find 085 * @return the social equity group setting 086 * @throws com.liferay.portlet.social.NoSuchEquityGroupSettingException if a social equity group 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.SocialEquityGroupSetting findByPrimaryKey( 090 long equityGroupSettingId) 091 throws com.liferay.portal.kernel.exception.SystemException, 092 com.liferay.portlet.social.NoSuchEquityGroupSettingException; 093 094 /** 095 * Finds the social equity group setting with the primary key or returns <code>null</code> if it could not be found. 096 * 097 * @param equityGroupSettingId the primary key of the social equity group setting to find 098 * @return the social equity group setting, or <code>null</code> if a social equity group 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.SocialEquityGroupSetting fetchByPrimaryKey( 102 long equityGroupSettingId) 103 throws com.liferay.portal.kernel.exception.SystemException; 104 105 /** 106 * Finds the social equity group setting where groupId = ? and classNameId = ? and type = ? or throws a {@link com.liferay.portlet.social.NoSuchEquityGroupSettingException} if it could not be found. 107 * 108 * @param groupId the group id to search with 109 * @param classNameId the class name id to search with 110 * @param type the type to search with 111 * @return the matching social equity group setting 112 * @throws com.liferay.portlet.social.NoSuchEquityGroupSettingException if a matching social equity group setting could not be found 113 * @throws SystemException if a system exception occurred 114 */ 115 public com.liferay.portlet.social.model.SocialEquityGroupSetting findByG_C_T( 116 long groupId, long classNameId, int type) 117 throws com.liferay.portal.kernel.exception.SystemException, 118 com.liferay.portlet.social.NoSuchEquityGroupSettingException; 119 120 /** 121 * Finds the social equity group setting where groupId = ? and classNameId = ? and type = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 122 * 123 * @param groupId the group id to search with 124 * @param classNameId the class name id to search with 125 * @param type the type to search with 126 * @return the matching social equity group setting, or <code>null</code> if a matching social equity group setting could not be found 127 * @throws SystemException if a system exception occurred 128 */ 129 public com.liferay.portlet.social.model.SocialEquityGroupSetting fetchByG_C_T( 130 long groupId, long classNameId, int type) 131 throws com.liferay.portal.kernel.exception.SystemException; 132 133 /** 134 * Finds the social equity group setting where groupId = ? and classNameId = ? and type = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 135 * 136 * @param groupId the group id to search with 137 * @param classNameId the class name id to search with 138 * @param type the type to search with 139 * @return the matching social equity group setting, or <code>null</code> if a matching social equity group setting could not be found 140 * @throws SystemException if a system exception occurred 141 */ 142 public com.liferay.portlet.social.model.SocialEquityGroupSetting fetchByG_C_T( 143 long groupId, long classNameId, int type, boolean retrieveFromCache) 144 throws com.liferay.portal.kernel.exception.SystemException; 145 146 /** 147 * Finds all the social equity group settings. 148 * 149 * @return the social equity group settings 150 * @throws SystemException if a system exception occurred 151 */ 152 public java.util.List<com.liferay.portlet.social.model.SocialEquityGroupSetting> findAll() 153 throws com.liferay.portal.kernel.exception.SystemException; 154 155 /** 156 * Finds a range of all the social equity group settings. 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 start the lower bound of the range of social equity group settings to return 163 * @param end the upper bound of the range of social equity group settings to return (not inclusive) 164 * @return the range of social equity group settings 165 * @throws SystemException if a system exception occurred 166 */ 167 public java.util.List<com.liferay.portlet.social.model.SocialEquityGroupSetting> findAll( 168 int start, int end) 169 throws com.liferay.portal.kernel.exception.SystemException; 170 171 /** 172 * Finds an ordered range of all the social equity group settings. 173 * 174 * <p> 175 * 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. 176 * </p> 177 * 178 * @param start the lower bound of the range of social equity group settings to return 179 * @param end the upper bound of the range of social equity group settings to return (not inclusive) 180 * @param orderByComparator the comparator to order the results by 181 * @return the ordered range of social equity group settings 182 * @throws SystemException if a system exception occurred 183 */ 184 public java.util.List<com.liferay.portlet.social.model.SocialEquityGroupSetting> findAll( 185 int start, int end, 186 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 187 throws com.liferay.portal.kernel.exception.SystemException; 188 189 /** 190 * Removes the social equity group setting where groupId = ? and classNameId = ? and type = ? from the database. 191 * 192 * @param groupId the group id to search with 193 * @param classNameId the class name id to search with 194 * @param type the type to search with 195 * @throws SystemException if a system exception occurred 196 */ 197 public void removeByG_C_T(long groupId, long classNameId, int type) 198 throws com.liferay.portal.kernel.exception.SystemException, 199 com.liferay.portlet.social.NoSuchEquityGroupSettingException; 200 201 /** 202 * Removes all the social equity group settings from the database. 203 * 204 * @throws SystemException if a system exception occurred 205 */ 206 public void removeAll() 207 throws com.liferay.portal.kernel.exception.SystemException; 208 209 /** 210 * Counts all the social equity group settings where groupId = ? and classNameId = ? and type = ?. 211 * 212 * @param groupId the group id to search with 213 * @param classNameId the class name id to search with 214 * @param type the type to search with 215 * @return the number of matching social equity group settings 216 * @throws SystemException if a system exception occurred 217 */ 218 public int countByG_C_T(long groupId, long classNameId, int type) 219 throws com.liferay.portal.kernel.exception.SystemException; 220 221 /** 222 * Counts all the social equity group settings. 223 * 224 * @return the number of social equity group settings 225 * @throws SystemException if a system exception occurred 226 */ 227 public int countAll() 228 throws com.liferay.portal.kernel.exception.SystemException; 229 }