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 com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 185 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public java.util.Date getLastPostDateByUserId(long groupId, long userId); 188 189 /** 190 * Returns the message boards stats user with the primary key. 191 * 192 * @param statsUserId the primary key of the message boards stats user 193 * @return the message boards stats user 194 * @throws PortalException if a message boards stats user with the primary key could not be found 195 */ 196 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 197 public com.liferay.portlet.messageboards.model.MBStatsUser getMBStatsUser( 198 long statsUserId) throws PortalException; 199 200 /** 201 * Returns a range of all the message boards stats users. 202 * 203 * <p> 204 * 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. 205 * </p> 206 * 207 * @param start the lower bound of the range of message boards stats users 208 * @param end the upper bound of the range of message boards stats users (not inclusive) 209 * @return the range of message boards stats users 210 */ 211 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 212 public java.util.List<com.liferay.portlet.messageboards.model.MBStatsUser> getMBStatsUsers( 213 int start, int end); 214 215 /** 216 * Returns the number of message boards stats users. 217 * 218 * @return the number of message boards stats users 219 */ 220 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 221 public int getMBStatsUsersCount(); 222 223 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 224 public long getMessageCountByGroupId(long groupId); 225 226 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 227 public long getMessageCountByUserId(long userId); 228 229 /** 230 * Returns the OSGi service identifier. 231 * 232 * @return the OSGi service identifier 233 */ 234 public java.lang.String getOSGiServiceIdentifier(); 235 236 @Override 237 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 238 public com.liferay.portal.model.PersistedModel getPersistedModel( 239 java.io.Serializable primaryKeyObj) throws PortalException; 240 241 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 242 public com.liferay.portlet.messageboards.model.MBStatsUser getStatsUser( 243 long groupId, long userId); 244 245 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 246 public java.util.List<com.liferay.portlet.messageboards.model.MBStatsUser> getStatsUsersByGroupId( 247 long groupId, int start, int end) throws PortalException; 248 249 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 250 public int getStatsUsersByGroupIdCount(long groupId) 251 throws PortalException; 252 253 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 254 public java.util.List<com.liferay.portlet.messageboards.model.MBStatsUser> getStatsUsersByUserId( 255 long userId); 256 257 /** 258 * Updates the message boards stats user in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 259 * 260 * @param mbStatsUser the message boards stats user 261 * @return the message boards stats user that was updated 262 */ 263 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 264 public com.liferay.portlet.messageboards.model.MBStatsUser updateMBStatsUser( 265 com.liferay.portlet.messageboards.model.MBStatsUser mbStatsUser); 266 267 public com.liferay.portlet.messageboards.model.MBStatsUser updateStatsUser( 268 long groupId, long userId); 269 270 public com.liferay.portlet.messageboards.model.MBStatsUser updateStatsUser( 271 long groupId, long userId, java.util.Date lastPostDate); 272 273 public com.liferay.portlet.messageboards.model.MBStatsUser updateStatsUser( 274 long groupId, long userId, int messageCount, java.util.Date lastPostDate); 275 }