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