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) throws PortalException;
093    
094            /**
095            * @throws PortalException
096            */
097            @Override
098            public com.liferay.portal.model.PersistedModel deletePersistedModel(
099                    com.liferay.portal.model.PersistedModel persistedModel)
100                    throws PortalException;
101    
102            public void deleteStatsUser(
103                    com.liferay.portlet.messageboards.model.MBStatsUser statsUser);
104    
105            public void deleteStatsUser(long statsUserId) throws PortalException;
106    
107            public void deleteStatsUsersByGroupId(long groupId);
108    
109            public void deleteStatsUsersByUserId(long userId);
110    
111            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
112    
113            /**
114            * Performs a dynamic query on the database and returns the matching rows.
115            *
116            * @param dynamicQuery the dynamic query
117            * @return the matching rows
118            */
119            public <T> java.util.List<T> dynamicQuery(
120                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
121    
122            /**
123            * Performs a dynamic query on the database and returns a range of the matching rows.
124            *
125            * <p>
126            * 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.
127            * </p>
128            *
129            * @param dynamicQuery the dynamic query
130            * @param start the lower bound of the range of model instances
131            * @param end the upper bound of the range of model instances (not inclusive)
132            * @return the range of matching rows
133            */
134            public <T> java.util.List<T> dynamicQuery(
135                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
136                    int end);
137    
138            /**
139            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
140            *
141            * <p>
142            * 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.
143            * </p>
144            *
145            * @param dynamicQuery the dynamic query
146            * @param start the lower bound of the range of model instances
147            * @param end the upper bound of the range of model instances (not inclusive)
148            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
149            * @return the ordered range of matching rows
150            */
151            public <T> java.util.List<T> dynamicQuery(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
153                    int end,
154                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
155    
156            /**
157            * Returns the number of rows matching the dynamic query.
158            *
159            * @param dynamicQuery the dynamic query
160            * @return the number of rows matching the dynamic query
161            */
162            public long dynamicQueryCount(
163                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
164    
165            /**
166            * Returns the number of rows matching the dynamic query.
167            *
168            * @param dynamicQuery the dynamic query
169            * @param projection the projection to apply to the query
170            * @return the number of rows matching the dynamic query
171            */
172            public long dynamicQueryCount(
173                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
174                    com.liferay.portal.kernel.dao.orm.Projection projection);
175    
176            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
177            public com.liferay.portlet.messageboards.model.MBStatsUser fetchMBStatsUser(
178                    long statsUserId);
179    
180            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
181            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
182    
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public java.util.Date getLastPostDateByUserId(long groupId, long userId);
185    
186            /**
187            * Returns the message boards stats user with the primary key.
188            *
189            * @param statsUserId the primary key of the message boards stats user
190            * @return the message boards stats user
191            * @throws PortalException if a message boards stats user with the primary key could not be found
192            */
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public com.liferay.portlet.messageboards.model.MBStatsUser getMBStatsUser(
195                    long statsUserId) throws PortalException;
196    
197            /**
198            * Returns a range of all the message boards stats users.
199            *
200            * <p>
201            * 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.
202            * </p>
203            *
204            * @param start the lower bound of the range of message boards stats users
205            * @param end the upper bound of the range of message boards stats users (not inclusive)
206            * @return the range of message boards stats users
207            */
208            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209            public java.util.List<com.liferay.portlet.messageboards.model.MBStatsUser> getMBStatsUsers(
210                    int start, int end);
211    
212            /**
213            * Returns the number of message boards stats users.
214            *
215            * @return the number of message boards stats users
216            */
217            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218            public int getMBStatsUsersCount();
219    
220            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
221            public long getMessageCountByGroupId(long groupId);
222    
223            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
224            public long getMessageCountByUserId(long userId);
225    
226            /**
227            * Returns the OSGi service identifier.
228            *
229            * @return the OSGi service identifier
230            */
231            public java.lang.String getOSGiServiceIdentifier();
232    
233            @Override
234            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
235            public com.liferay.portal.model.PersistedModel getPersistedModel(
236                    java.io.Serializable primaryKeyObj) throws PortalException;
237    
238            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
239            public com.liferay.portlet.messageboards.model.MBStatsUser getStatsUser(
240                    long groupId, long userId);
241    
242            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
243            public java.util.List<com.liferay.portlet.messageboards.model.MBStatsUser> getStatsUsersByGroupId(
244                    long groupId, int start, int end) throws PortalException;
245    
246            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
247            public int getStatsUsersByGroupIdCount(long groupId)
248                    throws PortalException;
249    
250            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
251            public java.util.List<com.liferay.portlet.messageboards.model.MBStatsUser> getStatsUsersByUserId(
252                    long userId);
253    
254            /**
255            * Updates the message boards stats user in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
256            *
257            * @param mbStatsUser the message boards stats user
258            * @return the message boards stats user that was updated
259            */
260            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
261            public com.liferay.portlet.messageboards.model.MBStatsUser updateMBStatsUser(
262                    com.liferay.portlet.messageboards.model.MBStatsUser mbStatsUser);
263    
264            public com.liferay.portlet.messageboards.model.MBStatsUser updateStatsUser(
265                    long groupId, long userId);
266    
267            public com.liferay.portlet.messageboards.model.MBStatsUser updateStatsUser(
268                    long groupId, long userId, java.util.Date lastPostDate);
269    
270            public com.liferay.portlet.messageboards.model.MBStatsUser updateStatsUser(
271                    long groupId, long userId, int messageCount, java.util.Date lastPostDate);
272    }