001 /** 002 * Copyright (c) 2000-2011 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; 016 017 import com.liferay.portal.kernel.exception.PortalException; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.kernel.transaction.Isolation; 020 import com.liferay.portal.kernel.transaction.Propagation; 021 import com.liferay.portal.kernel.transaction.Transactional; 022 import com.liferay.portal.service.PersistedModelLocalService; 023 024 /** 025 * The interface for the social equity group setting local service. 026 * 027 * <p> 028 * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM. 029 * </p> 030 * 031 * @author Brian Wing Shun Chan 032 * @see SocialEquityGroupSettingLocalServiceUtil 033 * @see com.liferay.portlet.social.service.base.SocialEquityGroupSettingLocalServiceBaseImpl 034 * @see com.liferay.portlet.social.service.impl.SocialEquityGroupSettingLocalServiceImpl 035 * @generated 036 */ 037 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 038 PortalException.class, SystemException.class}) 039 public interface SocialEquityGroupSettingLocalService 040 extends PersistedModelLocalService { 041 /* 042 * NOTE FOR DEVELOPERS: 043 * 044 * Never modify or reference this interface directly. Always use {@link SocialEquityGroupSettingLocalServiceUtil} to access the social equity group setting local service. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialEquityGroupSettingLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 045 */ 046 047 /** 048 * Adds the social equity group setting to the database. Also notifies the appropriate model listeners. 049 * 050 * @param socialEquityGroupSetting the social equity group setting 051 * @return the social equity group setting that was added 052 * @throws SystemException if a system exception occurred 053 */ 054 public com.liferay.portlet.social.model.SocialEquityGroupSetting addSocialEquityGroupSetting( 055 com.liferay.portlet.social.model.SocialEquityGroupSetting socialEquityGroupSetting) 056 throws com.liferay.portal.kernel.exception.SystemException; 057 058 /** 059 * Creates a new social equity group setting with the primary key. Does not add the social equity group setting to the database. 060 * 061 * @param equityGroupSettingId the primary key for the new social equity group setting 062 * @return the new social equity group setting 063 */ 064 public com.liferay.portlet.social.model.SocialEquityGroupSetting createSocialEquityGroupSetting( 065 long equityGroupSettingId); 066 067 /** 068 * Deletes the social equity group setting with the primary key from the database. Also notifies the appropriate model listeners. 069 * 070 * @param equityGroupSettingId the primary key of the social equity group setting 071 * @throws PortalException if a social equity group setting with the primary key could not be found 072 * @throws SystemException if a system exception occurred 073 */ 074 public void deleteSocialEquityGroupSetting(long equityGroupSettingId) 075 throws com.liferay.portal.kernel.exception.PortalException, 076 com.liferay.portal.kernel.exception.SystemException; 077 078 /** 079 * Deletes the social equity group setting from the database. Also notifies the appropriate model listeners. 080 * 081 * @param socialEquityGroupSetting the social equity group setting 082 * @throws SystemException if a system exception occurred 083 */ 084 public void deleteSocialEquityGroupSetting( 085 com.liferay.portlet.social.model.SocialEquityGroupSetting socialEquityGroupSetting) 086 throws com.liferay.portal.kernel.exception.SystemException; 087 088 /** 089 * Performs a dynamic query on the database and returns the matching rows. 090 * 091 * @param dynamicQuery the dynamic query 092 * @return the matching rows 093 * @throws SystemException if a system exception occurred 094 */ 095 @SuppressWarnings("rawtypes") 096 public java.util.List dynamicQuery( 097 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 098 throws com.liferay.portal.kernel.exception.SystemException; 099 100 /** 101 * Performs a dynamic query on the database and returns a range of the matching rows. 102 * 103 * <p> 104 * 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. 105 * </p> 106 * 107 * @param dynamicQuery the dynamic query 108 * @param start the lower bound of the range of model instances 109 * @param end the upper bound of the range of model instances (not inclusive) 110 * @return the range of matching rows 111 * @throws SystemException if a system exception occurred 112 */ 113 @SuppressWarnings("rawtypes") 114 public java.util.List dynamicQuery( 115 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 116 int end) throws com.liferay.portal.kernel.exception.SystemException; 117 118 /** 119 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 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 dynamicQuery the dynamic query 126 * @param start the lower bound of the range of model instances 127 * @param end the upper bound of the range of model instances (not inclusive) 128 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 129 * @return the ordered range of matching rows 130 * @throws SystemException if a system exception occurred 131 */ 132 @SuppressWarnings("rawtypes") 133 public java.util.List dynamicQuery( 134 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 135 int end, 136 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 137 throws com.liferay.portal.kernel.exception.SystemException; 138 139 /** 140 * Returns the number of rows that match the dynamic query. 141 * 142 * @param dynamicQuery the dynamic query 143 * @return the number of rows that match the dynamic query 144 * @throws SystemException if a system exception occurred 145 */ 146 public long dynamicQueryCount( 147 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 148 throws com.liferay.portal.kernel.exception.SystemException; 149 150 /** 151 * Returns the social equity group setting with the primary key. 152 * 153 * @param equityGroupSettingId the primary key of the social equity group setting 154 * @return the social equity group setting 155 * @throws PortalException if a social equity group setting with the primary key could not be found 156 * @throws SystemException if a system exception occurred 157 */ 158 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 159 public com.liferay.portlet.social.model.SocialEquityGroupSetting getSocialEquityGroupSetting( 160 long equityGroupSettingId) 161 throws com.liferay.portal.kernel.exception.PortalException, 162 com.liferay.portal.kernel.exception.SystemException; 163 164 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 165 public com.liferay.portal.model.PersistedModel getPersistedModel( 166 java.io.Serializable primaryKeyObj) 167 throws com.liferay.portal.kernel.exception.PortalException, 168 com.liferay.portal.kernel.exception.SystemException; 169 170 /** 171 * Returns a range of all the social equity group settings. 172 * 173 * <p> 174 * 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. 175 * </p> 176 * 177 * @param start the lower bound of the range of social equity group settings 178 * @param end the upper bound of the range of social equity group settings (not inclusive) 179 * @return the range of social equity group settings 180 * @throws SystemException if a system exception occurred 181 */ 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public java.util.List<com.liferay.portlet.social.model.SocialEquityGroupSetting> getSocialEquityGroupSettings( 184 int start, int end) 185 throws com.liferay.portal.kernel.exception.SystemException; 186 187 /** 188 * Returns the number of social equity group settings. 189 * 190 * @return the number of social equity group settings 191 * @throws SystemException if a system exception occurred 192 */ 193 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 194 public int getSocialEquityGroupSettingsCount() 195 throws com.liferay.portal.kernel.exception.SystemException; 196 197 /** 198 * Updates the social equity group setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 199 * 200 * @param socialEquityGroupSetting the social equity group setting 201 * @return the social equity group setting that was updated 202 * @throws SystemException if a system exception occurred 203 */ 204 public com.liferay.portlet.social.model.SocialEquityGroupSetting updateSocialEquityGroupSetting( 205 com.liferay.portlet.social.model.SocialEquityGroupSetting socialEquityGroupSetting) 206 throws com.liferay.portal.kernel.exception.SystemException; 207 208 /** 209 * Updates the social equity group setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 210 * 211 * @param socialEquityGroupSetting the social equity group setting 212 * @param merge whether to merge the social equity group setting with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation. 213 * @return the social equity group setting that was updated 214 * @throws SystemException if a system exception occurred 215 */ 216 public com.liferay.portlet.social.model.SocialEquityGroupSetting updateSocialEquityGroupSetting( 217 com.liferay.portlet.social.model.SocialEquityGroupSetting socialEquityGroupSetting, 218 boolean merge) 219 throws com.liferay.portal.kernel.exception.SystemException; 220 221 /** 222 * Returns the Spring bean ID for this bean. 223 * 224 * @return the Spring bean ID for this bean 225 */ 226 public java.lang.String getBeanIdentifier(); 227 228 /** 229 * Sets the Spring bean ID for this bean. 230 * 231 * @param beanIdentifier the Spring bean ID for this bean 232 */ 233 public void setBeanIdentifier(java.lang.String beanIdentifier); 234 235 /** 236 * Returns <code>true</code> if social equity is turned on for the model 237 * (asset type) in the group. 238 * 239 * @param groupId the primary key of the group 240 * @param className the class name for the target asset type 241 * @return <code>true</code> if social equity is enabled for the model; 242 <code>false</code> otherwise 243 * @throws SystemException if a system exception occurred 244 */ 245 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 246 public boolean isEnabled(long groupId, java.lang.String className) 247 throws com.liferay.portal.kernel.exception.SystemException; 248 249 /** 250 * Returns <code>true</code> if the specified social equity scoring type is 251 * turned on for the model (asset type) in the group. 252 * 253 * @param groupId the primary key of the group 254 * @param className the class name for the target asset type 255 * @param type the social equity score type, acceptable values are {@link 256 SocialEquitySettingConstants.TYPE_INFORMATION} and {@link 257 SocialEquitySettingConstants.TYPE_PARTICIPATION} 258 * @return <code>true</code> if the given type of social equity scoring is 259 enabled for the model; <code>false</code> otherwise 260 * @throws SystemException if a system exception occurred 261 */ 262 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 263 public boolean isEnabled(long groupId, java.lang.String className, int type) 264 throws com.liferay.portal.kernel.exception.SystemException; 265 266 /** 267 * Updates the group related social equity settings for the group and model 268 * (asset type). 269 * 270 * <p> 271 * This method stores whether the social equity scoring type (information 272 * or participation) is turned on for the model in the group. 273 * </p> 274 * 275 * @param groupId the primary key of the group 276 * @param className the class name for the target asset 277 * @param type the social equity score type, acceptable values are {@link 278 SocialEquitySettingConstants.TYPE_INFORMATION}, {@link 279 SocialEquitySettingConstants.TYPE_PARTICIPATION} 280 * @param enabled whether social equity is turned on 281 * @throws PortalException if the group could not be found 282 * @throws SystemException if a system exception occurred 283 */ 284 public void updateEquityGroupSetting(long groupId, 285 java.lang.String className, int type, boolean enabled) 286 throws com.liferay.portal.kernel.exception.PortalException, 287 com.liferay.portal.kernel.exception.SystemException; 288 }