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 SocialActivityAchievement. 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 SocialActivityAchievementLocalServiceUtil 036 * @see com.liferay.portlet.social.service.base.SocialActivityAchievementLocalServiceBaseImpl 037 * @see com.liferay.portlet.social.service.impl.SocialActivityAchievementLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface SocialActivityAchievementLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. Always use {@link SocialActivityAchievementLocalServiceUtil} to access the social activity achievement local service. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialActivityAchievementLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 049 */ 050 public void addActivityAchievement(long userId, long groupId, 051 com.liferay.portlet.social.model.SocialAchievement achievement) 052 throws com.liferay.portal.kernel.exception.PortalException; 053 054 /** 055 * Adds the social activity achievement to the database. Also notifies the appropriate model listeners. 056 * 057 * @param socialActivityAchievement the social activity achievement 058 * @return the social activity achievement that was added 059 */ 060 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 061 public com.liferay.portlet.social.model.SocialActivityAchievement addSocialActivityAchievement( 062 com.liferay.portlet.social.model.SocialActivityAchievement socialActivityAchievement); 063 064 /** 065 * Creates a new social activity achievement with the primary key. Does not add the social activity achievement to the database. 066 * 067 * @param activityAchievementId the primary key for the new social activity achievement 068 * @return the new social activity achievement 069 */ 070 public com.liferay.portlet.social.model.SocialActivityAchievement createSocialActivityAchievement( 071 long activityAchievementId); 072 073 /** 074 * @throws PortalException 075 */ 076 @Override 077 public com.liferay.portal.model.PersistedModel deletePersistedModel( 078 com.liferay.portal.model.PersistedModel persistedModel) 079 throws com.liferay.portal.kernel.exception.PortalException; 080 081 /** 082 * Deletes the social activity achievement with the primary key from the database. Also notifies the appropriate model listeners. 083 * 084 * @param activityAchievementId the primary key of the social activity achievement 085 * @return the social activity achievement that was removed 086 * @throws PortalException if a social activity achievement with the primary key could not be found 087 */ 088 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 089 public com.liferay.portlet.social.model.SocialActivityAchievement deleteSocialActivityAchievement( 090 long activityAchievementId) 091 throws com.liferay.portal.kernel.exception.PortalException; 092 093 /** 094 * Deletes the social activity achievement from the database. Also notifies the appropriate model listeners. 095 * 096 * @param socialActivityAchievement the social activity achievement 097 * @return the social activity achievement that was removed 098 */ 099 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 100 public com.liferay.portlet.social.model.SocialActivityAchievement deleteSocialActivityAchievement( 101 com.liferay.portlet.social.model.SocialActivityAchievement socialActivityAchievement); 102 103 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 104 105 /** 106 * Performs a dynamic query on the database and returns the matching rows. 107 * 108 * @param dynamicQuery the dynamic query 109 * @return the matching rows 110 */ 111 public <T> java.util.List<T> dynamicQuery( 112 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 113 114 /** 115 * Performs a dynamic query on the database and returns a range of the matching rows. 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. 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.SocialActivityAchievementModelImpl}. 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. 119 * </p> 120 * 121 * @param dynamicQuery the dynamic query 122 * @param start the lower bound of the range of model instances 123 * @param end the upper bound of the range of model instances (not inclusive) 124 * @return the range of matching rows 125 */ 126 public <T> java.util.List<T> dynamicQuery( 127 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 128 int end); 129 130 /** 131 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 132 * 133 * <p> 134 * 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.SocialActivityAchievementModelImpl}. 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. 135 * </p> 136 * 137 * @param dynamicQuery the dynamic query 138 * @param start the lower bound of the range of model instances 139 * @param end the upper bound of the range of model instances (not inclusive) 140 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 141 * @return the ordered range of matching rows 142 */ 143 public <T> java.util.List<T> dynamicQuery( 144 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 145 int end, 146 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 147 148 /** 149 * Returns the number of rows matching the dynamic query. 150 * 151 * @param dynamicQuery the dynamic query 152 * @return the number of rows matching the dynamic query 153 */ 154 public long dynamicQueryCount( 155 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 156 157 /** 158 * Returns the number of rows matching the dynamic query. 159 * 160 * @param dynamicQuery the dynamic query 161 * @param projection the projection to apply to the query 162 * @return the number of rows matching the dynamic query 163 */ 164 public long dynamicQueryCount( 165 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 166 com.liferay.portal.kernel.dao.orm.Projection projection); 167 168 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 169 public com.liferay.portlet.social.model.SocialActivityAchievement fetchSocialActivityAchievement( 170 long activityAchievementId); 171 172 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 173 public com.liferay.portlet.social.model.SocialActivityAchievement fetchUserAchievement( 174 long userId, long groupId, java.lang.String name); 175 176 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 177 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 178 179 /** 180 * Returns the Spring bean ID for this bean. 181 * 182 * @return the Spring bean ID for this bean 183 */ 184 public java.lang.String getBeanIdentifier(); 185 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public java.util.List<com.liferay.portlet.social.model.SocialActivityAchievement> getGroupAchievements( 188 long groupId); 189 190 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 191 public java.util.List<com.liferay.portlet.social.model.SocialActivityAchievement> getGroupAchievements( 192 long groupId, java.lang.String name); 193 194 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 195 public int getGroupAchievementsCount(long groupId); 196 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public int getGroupAchievementsCount(long groupId, java.lang.String name); 199 200 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 201 public java.util.List<com.liferay.portlet.social.model.SocialActivityAchievement> getGroupFirstAchievements( 202 long groupId); 203 204 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 205 public int getGroupFirstAchievementsCount(long groupId); 206 207 @Override 208 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 209 public com.liferay.portal.model.PersistedModel getPersistedModel( 210 java.io.Serializable primaryKeyObj) 211 throws com.liferay.portal.kernel.exception.PortalException; 212 213 /** 214 * Returns the social activity achievement with the primary key. 215 * 216 * @param activityAchievementId the primary key of the social activity achievement 217 * @return the social activity achievement 218 * @throws PortalException if a social activity achievement with the primary key could not be found 219 */ 220 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 221 public com.liferay.portlet.social.model.SocialActivityAchievement getSocialActivityAchievement( 222 long activityAchievementId) 223 throws com.liferay.portal.kernel.exception.PortalException; 224 225 /** 226 * Returns a range of all the social activity achievements. 227 * 228 * <p> 229 * 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.SocialActivityAchievementModelImpl}. 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. 230 * </p> 231 * 232 * @param start the lower bound of the range of social activity achievements 233 * @param end the upper bound of the range of social activity achievements (not inclusive) 234 * @return the range of social activity achievements 235 */ 236 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 237 public java.util.List<com.liferay.portlet.social.model.SocialActivityAchievement> getSocialActivityAchievements( 238 int start, int end); 239 240 /** 241 * Returns the number of social activity achievements. 242 * 243 * @return the number of social activity achievements 244 */ 245 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 246 public int getSocialActivityAchievementsCount(); 247 248 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 249 public java.util.List<com.liferay.portlet.social.model.SocialActivityAchievement> getUserAchievements( 250 long userId, long groupId); 251 252 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 253 public int getUserAchievementsCount(long userId, long groupId); 254 255 /** 256 * Sets the Spring bean ID for this bean. 257 * 258 * @param beanIdentifier the Spring bean ID for this bean 259 */ 260 public void setBeanIdentifier(java.lang.String beanIdentifier); 261 262 /** 263 * Updates the social activity achievement in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 264 * 265 * @param socialActivityAchievement the social activity achievement 266 * @return the social activity achievement that was updated 267 */ 268 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 269 public com.liferay.portlet.social.model.SocialActivityAchievement updateSocialActivityAchievement( 270 com.liferay.portlet.social.model.SocialActivityAchievement socialActivityAchievement); 271 }