001 /** 002 * Copyright (c) 2000-present 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 aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.search.IndexableType; 022 import com.liferay.portal.kernel.transaction.Isolation; 023 import com.liferay.portal.kernel.transaction.Propagation; 024 import com.liferay.portal.kernel.transaction.Transactional; 025 import com.liferay.portal.service.BaseLocalService; 026 import com.liferay.portal.service.PersistedModelLocalService; 027 028 /** 029 * Provides the local service interface for SocialActivitySetting. Methods of this 030 * service will not have security checks based on the propagated JAAS 031 * credentials because this service can only be accessed from within the same 032 * VM. 033 * 034 * @author Brian Wing Shun Chan 035 * @see SocialActivitySettingLocalServiceUtil 036 * @see com.liferay.portlet.social.service.base.SocialActivitySettingLocalServiceBaseImpl 037 * @see com.liferay.portlet.social.service.impl.SocialActivitySettingLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface SocialActivitySettingLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. Always use {@link SocialActivitySettingLocalServiceUtil} to access the social activity setting local service. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialActivitySettingLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 049 */ 050 051 /** 052 * Adds the social activity setting to the database. Also notifies the appropriate model listeners. 053 * 054 * @param socialActivitySetting the social activity setting 055 * @return the social activity setting that was added 056 */ 057 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 058 public com.liferay.portlet.social.model.SocialActivitySetting addSocialActivitySetting( 059 com.liferay.portlet.social.model.SocialActivitySetting socialActivitySetting); 060 061 /** 062 * Creates a new social activity setting with the primary key. Does not add the social activity setting to the database. 063 * 064 * @param activitySettingId the primary key for the new social activity setting 065 * @return the new social activity setting 066 */ 067 public com.liferay.portlet.social.model.SocialActivitySetting createSocialActivitySetting( 068 long activitySettingId); 069 070 public void deleteActivitySetting(long groupId, java.lang.String className, 071 long classPK); 072 073 public void deleteActivitySettings(long groupId); 074 075 /** 076 * @throws PortalException 077 */ 078 @Override 079 public com.liferay.portal.model.PersistedModel deletePersistedModel( 080 com.liferay.portal.model.PersistedModel persistedModel) 081 throws com.liferay.portal.kernel.exception.PortalException; 082 083 /** 084 * Deletes the social activity setting with the primary key from the database. Also notifies the appropriate model listeners. 085 * 086 * @param activitySettingId the primary key of the social activity setting 087 * @return the social activity setting that was removed 088 * @throws PortalException if a social activity setting with the primary key could not be found 089 */ 090 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 091 public com.liferay.portlet.social.model.SocialActivitySetting deleteSocialActivitySetting( 092 long activitySettingId) 093 throws com.liferay.portal.kernel.exception.PortalException; 094 095 /** 096 * Deletes the social activity setting from the database. Also notifies the appropriate model listeners. 097 * 098 * @param socialActivitySetting the social activity setting 099 * @return the social activity setting that was removed 100 */ 101 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 102 public com.liferay.portlet.social.model.SocialActivitySetting deleteSocialActivitySetting( 103 com.liferay.portlet.social.model.SocialActivitySetting socialActivitySetting); 104 105 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 106 107 /** 108 * Performs a dynamic query on the database and returns the matching rows. 109 * 110 * @param dynamicQuery the dynamic query 111 * @return the matching rows 112 */ 113 public <T> java.util.List<T> dynamicQuery( 114 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 115 116 /** 117 * Performs a dynamic query on the database and returns a range of the matching rows. 118 * 119 * <p> 120 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialActivitySettingModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 121 * </p> 122 * 123 * @param dynamicQuery the dynamic query 124 * @param start the lower bound of the range of model instances 125 * @param end the upper bound of the range of model instances (not inclusive) 126 * @return the range of matching rows 127 */ 128 public <T> java.util.List<T> dynamicQuery( 129 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 130 int end); 131 132 /** 133 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 134 * 135 * <p> 136 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialActivitySettingModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 137 * </p> 138 * 139 * @param dynamicQuery the dynamic query 140 * @param start the lower bound of the range of model instances 141 * @param end the upper bound of the range of model instances (not inclusive) 142 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 143 * @return the ordered range of matching rows 144 */ 145 public <T> java.util.List<T> dynamicQuery( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 147 int end, 148 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 149 150 /** 151 * Returns the number of rows matching the dynamic query. 152 * 153 * @param dynamicQuery the dynamic query 154 * @return the number of rows matching the dynamic query 155 */ 156 public long dynamicQueryCount( 157 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 158 159 /** 160 * Returns the number of rows matching the dynamic query. 161 * 162 * @param dynamicQuery the dynamic query 163 * @param projection the projection to apply to the query 164 * @return the number of rows matching the dynamic query 165 */ 166 public long dynamicQueryCount( 167 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 168 com.liferay.portal.kernel.dao.orm.Projection projection); 169 170 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 171 public com.liferay.portlet.social.model.SocialActivitySetting fetchSocialActivitySetting( 172 long activitySettingId); 173 174 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 175 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 176 177 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 178 public com.liferay.portlet.social.model.SocialActivityDefinition getActivityDefinition( 179 long groupId, java.lang.String className, int activityType); 180 181 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 182 public java.util.List<com.liferay.portlet.social.model.SocialActivityDefinition> getActivityDefinitions( 183 long groupId, java.lang.String className); 184 185 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 186 public java.util.List<com.liferay.portlet.social.model.SocialActivitySetting> getActivitySettings( 187 long groupId); 188 189 /** 190 * Returns the Spring bean ID for this bean. 191 * 192 * @return the Spring bean ID for this bean 193 */ 194 public java.lang.String getBeanIdentifier(); 195 196 @Override 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public com.liferay.portal.model.PersistedModel getPersistedModel( 199 java.io.Serializable primaryKeyObj) 200 throws com.liferay.portal.kernel.exception.PortalException; 201 202 /** 203 * Returns the social activity setting with the primary key. 204 * 205 * @param activitySettingId the primary key of the social activity setting 206 * @return the social activity setting 207 * @throws PortalException if a social activity setting with the primary key could not be found 208 */ 209 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 210 public com.liferay.portlet.social.model.SocialActivitySetting getSocialActivitySetting( 211 long activitySettingId) 212 throws com.liferay.portal.kernel.exception.PortalException; 213 214 /** 215 * Returns a range of all the social activity settings. 216 * 217 * <p> 218 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialActivitySettingModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 219 * </p> 220 * 221 * @param start the lower bound of the range of social activity settings 222 * @param end the upper bound of the range of social activity settings (not inclusive) 223 * @return the range of social activity settings 224 */ 225 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 226 public java.util.List<com.liferay.portlet.social.model.SocialActivitySetting> getSocialActivitySettings( 227 int start, int end); 228 229 /** 230 * Returns the number of social activity settings. 231 * 232 * @return the number of social activity settings 233 */ 234 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 235 public int getSocialActivitySettingsCount(); 236 237 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 238 public boolean isEnabled(long groupId, long classNameId); 239 240 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 241 public boolean isEnabled(long groupId, long classNameId, long classPK); 242 243 /** 244 * Sets the Spring bean ID for this bean. 245 * 246 * @param beanIdentifier the Spring bean ID for this bean 247 */ 248 public void setBeanIdentifier(java.lang.String beanIdentifier); 249 250 public void updateActivitySetting(long groupId, java.lang.String className, 251 int activityType, 252 com.liferay.portlet.social.model.SocialActivityCounterDefinition activityCounterDefinition) 253 throws com.liferay.portal.kernel.exception.PortalException; 254 255 public void updateActivitySetting(long groupId, java.lang.String className, 256 long classPK, boolean enabled) 257 throws com.liferay.portal.kernel.exception.PortalException; 258 259 public void updateActivitySetting(long groupId, java.lang.String className, 260 boolean enabled) 261 throws com.liferay.portal.kernel.exception.PortalException; 262 263 public void updateActivitySettings(long groupId, 264 java.lang.String className, int activityType, 265 java.util.List<com.liferay.portlet.social.model.SocialActivityCounterDefinition> activityCounterDefinitions) 266 throws com.liferay.portal.kernel.exception.PortalException; 267 268 /** 269 * Updates the social activity setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 270 * 271 * @param socialActivitySetting the social activity setting 272 * @return the social activity setting that was updated 273 */ 274 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 275 public com.liferay.portlet.social.model.SocialActivitySetting updateSocialActivitySetting( 276 com.liferay.portlet.social.model.SocialActivitySetting socialActivitySetting); 277 }