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 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) throws PortalException; 093 094 /** 095 * Deletes the social activity setting from the database. Also notifies the appropriate model listeners. 096 * 097 * @param socialActivitySetting the social activity setting 098 * @return the social activity setting that was removed 099 */ 100 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 101 public com.liferay.portlet.social.model.SocialActivitySetting deleteSocialActivitySetting( 102 com.liferay.portlet.social.model.SocialActivitySetting socialActivitySetting); 103 104 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 105 106 /** 107 * Performs a dynamic query on the database and returns the matching rows. 108 * 109 * @param dynamicQuery the dynamic query 110 * @return the matching rows 111 */ 112 public <T> java.util.List<T> dynamicQuery( 113 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 114 115 /** 116 * Performs a dynamic query on the database and returns a range of the matching rows. 117 * 118 * <p> 119 * 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. 120 * </p> 121 * 122 * @param dynamicQuery the dynamic query 123 * @param start the lower bound of the range of model instances 124 * @param end the upper bound of the range of model instances (not inclusive) 125 * @return the range of matching rows 126 */ 127 public <T> java.util.List<T> dynamicQuery( 128 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 129 int end); 130 131 /** 132 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 133 * 134 * <p> 135 * 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. 136 * </p> 137 * 138 * @param dynamicQuery the dynamic query 139 * @param start the lower bound of the range of model instances 140 * @param end the upper bound of the range of model instances (not inclusive) 141 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 142 * @return the ordered range of matching rows 143 */ 144 public <T> java.util.List<T> dynamicQuery( 145 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 146 int end, 147 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 148 149 /** 150 * Returns the number of rows matching the dynamic query. 151 * 152 * @param dynamicQuery the dynamic query 153 * @return the number of rows matching the dynamic query 154 */ 155 public long dynamicQueryCount( 156 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 157 158 /** 159 * Returns the number of rows matching the dynamic query. 160 * 161 * @param dynamicQuery the dynamic query 162 * @param projection the projection to apply to the query 163 * @return the number of rows matching the dynamic query 164 */ 165 public long dynamicQueryCount( 166 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 167 com.liferay.portal.kernel.dao.orm.Projection projection); 168 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public com.liferay.portlet.social.model.SocialActivitySetting fetchSocialActivitySetting( 171 long activitySettingId); 172 173 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 174 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 175 176 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 177 public com.liferay.portlet.social.model.SocialActivityDefinition getActivityDefinition( 178 long groupId, java.lang.String className, int activityType); 179 180 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 181 public java.util.List<com.liferay.portlet.social.model.SocialActivityDefinition> getActivityDefinitions( 182 long groupId, java.lang.String className); 183 184 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 185 public java.util.List<com.liferay.portlet.social.model.SocialActivitySetting> getActivitySettings( 186 long groupId); 187 188 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 189 public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 190 191 /** 192 * Returns the OSGi service identifier. 193 * 194 * @return the OSGi service identifier 195 */ 196 public java.lang.String getOSGiServiceIdentifier(); 197 198 @Override 199 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 200 public com.liferay.portal.model.PersistedModel getPersistedModel( 201 java.io.Serializable primaryKeyObj) throws PortalException; 202 203 /** 204 * Returns the social activity setting with the primary key. 205 * 206 * @param activitySettingId the primary key of the social activity setting 207 * @return the social activity setting 208 * @throws PortalException if a social activity setting with the primary key could not be found 209 */ 210 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 211 public com.liferay.portlet.social.model.SocialActivitySetting getSocialActivitySetting( 212 long activitySettingId) throws 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 public void updateActivitySetting(long groupId, java.lang.String className, 244 int activityType, 245 com.liferay.portlet.social.model.SocialActivityCounterDefinition activityCounterDefinition) 246 throws PortalException; 247 248 public void updateActivitySetting(long groupId, java.lang.String className, 249 long classPK, boolean enabled) throws PortalException; 250 251 public void updateActivitySetting(long groupId, java.lang.String className, 252 boolean enabled) throws PortalException; 253 254 public void updateActivitySettings(long groupId, 255 java.lang.String className, int activityType, 256 java.util.List<com.liferay.portlet.social.model.SocialActivityCounterDefinition> activityCounterDefinitions) 257 throws PortalException; 258 259 /** 260 * Updates the social activity setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 261 * 262 * @param socialActivitySetting the social activity setting 263 * @return the social activity setting that was updated 264 */ 265 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 266 public com.liferay.portlet.social.model.SocialActivitySetting updateSocialActivitySetting( 267 com.liferay.portlet.social.model.SocialActivitySetting socialActivitySetting); 268 }