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 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 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) throws PortalException;
091    
092            /**
093            * Deletes the social activity achievement from the database. Also notifies the appropriate model listeners.
094            *
095            * @param socialActivityAchievement the social activity achievement
096            * @return the social activity achievement that was removed
097            */
098            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
099            public com.liferay.portlet.social.model.SocialActivityAchievement deleteSocialActivityAchievement(
100                    com.liferay.portlet.social.model.SocialActivityAchievement socialActivityAchievement);
101    
102            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
103    
104            /**
105            * Performs a dynamic query on the database and returns the matching rows.
106            *
107            * @param dynamicQuery the dynamic query
108            * @return the matching rows
109            */
110            public <T> java.util.List<T> dynamicQuery(
111                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
112    
113            /**
114            * Performs a dynamic query on the database and returns a range of the matching rows.
115            *
116            * <p>
117            * 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.
118            * </p>
119            *
120            * @param dynamicQuery the dynamic query
121            * @param start the lower bound of the range of model instances
122            * @param end the upper bound of the range of model instances (not inclusive)
123            * @return the range of matching rows
124            */
125            public <T> java.util.List<T> dynamicQuery(
126                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
127                    int end);
128    
129            /**
130            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
131            *
132            * <p>
133            * 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.
134            * </p>
135            *
136            * @param dynamicQuery the dynamic query
137            * @param start the lower bound of the range of model instances
138            * @param end the upper bound of the range of model instances (not inclusive)
139            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
140            * @return the ordered range of matching rows
141            */
142            public <T> java.util.List<T> dynamicQuery(
143                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
144                    int end,
145                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
146    
147            /**
148            * Returns the number of rows matching the dynamic query.
149            *
150            * @param dynamicQuery the dynamic query
151            * @return the number of rows matching the dynamic query
152            */
153            public long dynamicQueryCount(
154                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
155    
156            /**
157            * Returns the number of rows matching the dynamic query.
158            *
159            * @param dynamicQuery the dynamic query
160            * @param projection the projection to apply to the query
161            * @return the number of rows matching the dynamic query
162            */
163            public long dynamicQueryCount(
164                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
165                    com.liferay.portal.kernel.dao.orm.Projection projection);
166    
167            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
168            public com.liferay.portlet.social.model.SocialActivityAchievement fetchSocialActivityAchievement(
169                    long activityAchievementId);
170    
171            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172            public com.liferay.portlet.social.model.SocialActivityAchievement fetchUserAchievement(
173                    long userId, long groupId, java.lang.String name);
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
177    
178            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179            public java.util.List<com.liferay.portlet.social.model.SocialActivityAchievement> getGroupAchievements(
180                    long groupId);
181    
182            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
183            public java.util.List<com.liferay.portlet.social.model.SocialActivityAchievement> getGroupAchievements(
184                    long groupId, java.lang.String name);
185    
186            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187            public int getGroupAchievementsCount(long groupId);
188    
189            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
190            public int getGroupAchievementsCount(long groupId, java.lang.String name);
191    
192            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193            public java.util.List<com.liferay.portlet.social.model.SocialActivityAchievement> getGroupFirstAchievements(
194                    long groupId);
195    
196            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
197            public int getGroupFirstAchievementsCount(long groupId);
198    
199            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
200            public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
201    
202            /**
203            * Returns the OSGi service identifier.
204            *
205            * @return the OSGi service identifier
206            */
207            public java.lang.String getOSGiServiceIdentifier();
208    
209            @Override
210            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
211            public com.liferay.portal.model.PersistedModel getPersistedModel(
212                    java.io.Serializable primaryKeyObj) throws PortalException;
213    
214            /**
215            * Returns the social activity achievement with the primary key.
216            *
217            * @param activityAchievementId the primary key of the social activity achievement
218            * @return the social activity achievement
219            * @throws PortalException if a social activity achievement with the primary key could not be found
220            */
221            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
222            public com.liferay.portlet.social.model.SocialActivityAchievement getSocialActivityAchievement(
223                    long activityAchievementId) throws 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            * Updates the social activity achievement in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
257            *
258            * @param socialActivityAchievement the social activity achievement
259            * @return the social activity achievement that was updated
260            */
261            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
262            public com.liferay.portlet.social.model.SocialActivityAchievement updateSocialActivityAchievement(
263                    com.liferay.portlet.social.model.SocialActivityAchievement socialActivityAchievement);
264    }