001 /** 002 * Copyright (c) 2000-2013 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.model.SystemEventConstants; 026 import com.liferay.portal.service.BaseLocalService; 027 import com.liferay.portal.service.PersistedModelLocalService; 028 029 /** 030 * Provides the local service interface for MBThreadFlag. Methods of this 031 * service will not have security checks based on the propagated JAAS 032 * credentials because this service can only be accessed from within the same 033 * VM. 034 * 035 * @author Brian Wing Shun Chan 036 * @see MBThreadFlagLocalServiceUtil 037 * @see com.liferay.portlet.messageboards.service.base.MBThreadFlagLocalServiceBaseImpl 038 * @see com.liferay.portlet.messageboards.service.impl.MBThreadFlagLocalServiceImpl 039 * @generated 040 */ 041 @ProviderType 042 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 043 PortalException.class, SystemException.class}) 044 public interface MBThreadFlagLocalService extends BaseLocalService, 045 PersistedModelLocalService { 046 /* 047 * NOTE FOR DEVELOPERS: 048 * 049 * Never modify or reference this interface directly. Always use {@link MBThreadFlagLocalServiceUtil} to access the message boards thread flag local service. Add custom service methods to {@link com.liferay.portlet.messageboards.service.impl.MBThreadFlagLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 050 */ 051 052 /** 053 * Adds the message boards thread flag to the database. Also notifies the appropriate model listeners. 054 * 055 * @param mbThreadFlag the message boards thread flag 056 * @return the message boards thread flag that was added 057 * @throws SystemException if a system exception occurred 058 */ 059 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 060 public com.liferay.portlet.messageboards.model.MBThreadFlag addMBThreadFlag( 061 com.liferay.portlet.messageboards.model.MBThreadFlag mbThreadFlag) 062 throws com.liferay.portal.kernel.exception.SystemException; 063 064 /** 065 * Creates a new message boards thread flag with the primary key. Does not add the message boards thread flag to the database. 066 * 067 * @param threadFlagId the primary key for the new message boards thread flag 068 * @return the new message boards thread flag 069 */ 070 public com.liferay.portlet.messageboards.model.MBThreadFlag createMBThreadFlag( 071 long threadFlagId); 072 073 /** 074 * Deletes the message boards thread flag with the primary key from the database. Also notifies the appropriate model listeners. 075 * 076 * @param threadFlagId the primary key of the message boards thread flag 077 * @return the message boards thread flag that was removed 078 * @throws PortalException if a message boards thread flag with the primary key could not be found 079 * @throws SystemException if a system exception occurred 080 */ 081 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 082 public com.liferay.portlet.messageboards.model.MBThreadFlag deleteMBThreadFlag( 083 long threadFlagId) 084 throws com.liferay.portal.kernel.exception.PortalException, 085 com.liferay.portal.kernel.exception.SystemException; 086 087 /** 088 * Deletes the message boards thread flag from the database. Also notifies the appropriate model listeners. 089 * 090 * @param mbThreadFlag the message boards thread flag 091 * @return the message boards thread flag that was removed 092 * @throws SystemException if a system exception occurred 093 */ 094 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 095 public com.liferay.portlet.messageboards.model.MBThreadFlag deleteMBThreadFlag( 096 com.liferay.portlet.messageboards.model.MBThreadFlag mbThreadFlag) 097 throws com.liferay.portal.kernel.exception.SystemException; 098 099 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 100 101 /** 102 * Performs a dynamic query on the database and returns the matching rows. 103 * 104 * @param dynamicQuery the dynamic query 105 * @return the matching rows 106 * @throws SystemException if a system exception occurred 107 */ 108 @SuppressWarnings("rawtypes") 109 public java.util.List dynamicQuery( 110 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 111 throws com.liferay.portal.kernel.exception.SystemException; 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.messageboards.model.impl.MBThreadFlagModelImpl}. 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 * @throws SystemException if a system exception occurred 125 */ 126 @SuppressWarnings("rawtypes") 127 public java.util.List dynamicQuery( 128 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 129 int end) throws com.liferay.portal.kernel.exception.SystemException; 130 131 /** 132 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 133 * 134 * <p> 135 * 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.MBThreadFlagModelImpl}. 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. 136 * </p> 137 * 138 * @param dynamicQuery the dynamic query 139 * @param start the lower bound of the range of model instances 140 * @param end the upper bound of the range of model instances (not inclusive) 141 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 142 * @return the ordered range of matching rows 143 * @throws SystemException if a system exception occurred 144 */ 145 @SuppressWarnings("rawtypes") 146 public java.util.List dynamicQuery( 147 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 148 int end, 149 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 150 throws com.liferay.portal.kernel.exception.SystemException; 151 152 /** 153 * Returns the number of rows that match the dynamic query. 154 * 155 * @param dynamicQuery the dynamic query 156 * @return the number of rows that match the dynamic query 157 * @throws SystemException if a system exception occurred 158 */ 159 public long dynamicQueryCount( 160 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 161 throws com.liferay.portal.kernel.exception.SystemException; 162 163 /** 164 * Returns the number of rows that match the dynamic query. 165 * 166 * @param dynamicQuery the dynamic query 167 * @param projection the projection to apply to the query 168 * @return the number of rows that match the dynamic query 169 * @throws SystemException if a system exception occurred 170 */ 171 public long dynamicQueryCount( 172 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 173 com.liferay.portal.kernel.dao.orm.Projection projection) 174 throws com.liferay.portal.kernel.exception.SystemException; 175 176 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 177 public com.liferay.portlet.messageboards.model.MBThreadFlag fetchMBThreadFlag( 178 long threadFlagId) 179 throws com.liferay.portal.kernel.exception.SystemException; 180 181 /** 182 * Returns the message boards thread flag with the matching UUID and company. 183 * 184 * @param uuid the message boards thread flag's UUID 185 * @param companyId the primary key of the company 186 * @return the matching message boards thread flag, or <code>null</code> if a matching message boards thread flag could not be found 187 * @throws SystemException if a system exception occurred 188 */ 189 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 190 public com.liferay.portlet.messageboards.model.MBThreadFlag fetchMBThreadFlagByUuidAndCompanyId( 191 java.lang.String uuid, long companyId) 192 throws com.liferay.portal.kernel.exception.SystemException; 193 194 /** 195 * Returns the message boards thread flag matching the UUID and group. 196 * 197 * @param uuid the message boards thread flag's UUID 198 * @param groupId the primary key of the group 199 * @return the matching message boards thread flag, or <code>null</code> if a matching message boards thread flag could not be found 200 * @throws SystemException if a system exception occurred 201 */ 202 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 203 public com.liferay.portlet.messageboards.model.MBThreadFlag fetchMBThreadFlagByUuidAndGroupId( 204 java.lang.String uuid, long groupId) 205 throws com.liferay.portal.kernel.exception.SystemException; 206 207 /** 208 * Returns the message boards thread flag with the primary key. 209 * 210 * @param threadFlagId the primary key of the message boards thread flag 211 * @return the message boards thread flag 212 * @throws PortalException if a message boards thread flag with the primary key could not be found 213 * @throws SystemException if a system exception occurred 214 */ 215 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 216 public com.liferay.portlet.messageboards.model.MBThreadFlag getMBThreadFlag( 217 long threadFlagId) 218 throws com.liferay.portal.kernel.exception.PortalException, 219 com.liferay.portal.kernel.exception.SystemException; 220 221 @Override 222 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 223 public com.liferay.portal.model.PersistedModel getPersistedModel( 224 java.io.Serializable primaryKeyObj) 225 throws com.liferay.portal.kernel.exception.PortalException, 226 com.liferay.portal.kernel.exception.SystemException; 227 228 /** 229 * Returns the message boards thread flag with the matching UUID and company. 230 * 231 * @param uuid the message boards thread flag's UUID 232 * @param companyId the primary key of the company 233 * @return the matching message boards thread flag 234 * @throws PortalException if a matching message boards thread flag could not be found 235 * @throws SystemException if a system exception occurred 236 */ 237 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 238 public com.liferay.portlet.messageboards.model.MBThreadFlag getMBThreadFlagByUuidAndCompanyId( 239 java.lang.String uuid, long companyId) 240 throws com.liferay.portal.kernel.exception.PortalException, 241 com.liferay.portal.kernel.exception.SystemException; 242 243 /** 244 * Returns the message boards thread flag matching the UUID and group. 245 * 246 * @param uuid the message boards thread flag's UUID 247 * @param groupId the primary key of the group 248 * @return the matching message boards thread flag 249 * @throws PortalException if a matching message boards thread flag could not be found 250 * @throws SystemException if a system exception occurred 251 */ 252 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 253 public com.liferay.portlet.messageboards.model.MBThreadFlag getMBThreadFlagByUuidAndGroupId( 254 java.lang.String uuid, long groupId) 255 throws com.liferay.portal.kernel.exception.PortalException, 256 com.liferay.portal.kernel.exception.SystemException; 257 258 /** 259 * Returns a range of all the message boards thread flags. 260 * 261 * <p> 262 * 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.MBThreadFlagModelImpl}. 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. 263 * </p> 264 * 265 * @param start the lower bound of the range of message boards thread flags 266 * @param end the upper bound of the range of message boards thread flags (not inclusive) 267 * @return the range of message boards thread flags 268 * @throws SystemException if a system exception occurred 269 */ 270 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 271 public java.util.List<com.liferay.portlet.messageboards.model.MBThreadFlag> getMBThreadFlags( 272 int start, int end) 273 throws com.liferay.portal.kernel.exception.SystemException; 274 275 /** 276 * Returns the number of message boards thread flags. 277 * 278 * @return the number of message boards thread flags 279 * @throws SystemException if a system exception occurred 280 */ 281 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 282 public int getMBThreadFlagsCount() 283 throws com.liferay.portal.kernel.exception.SystemException; 284 285 /** 286 * Updates the message boards thread flag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 287 * 288 * @param mbThreadFlag the message boards thread flag 289 * @return the message boards thread flag that was updated 290 * @throws SystemException if a system exception occurred 291 */ 292 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 293 public com.liferay.portlet.messageboards.model.MBThreadFlag updateMBThreadFlag( 294 com.liferay.portlet.messageboards.model.MBThreadFlag mbThreadFlag) 295 throws com.liferay.portal.kernel.exception.SystemException; 296 297 /** 298 * Returns the Spring bean ID for this bean. 299 * 300 * @return the Spring bean ID for this bean 301 */ 302 public java.lang.String getBeanIdentifier(); 303 304 /** 305 * Sets the Spring bean ID for this bean. 306 * 307 * @param beanIdentifier the Spring bean ID for this bean 308 */ 309 public void setBeanIdentifier(java.lang.String beanIdentifier); 310 311 public void addThreadFlag(long userId, 312 com.liferay.portlet.messageboards.model.MBThread thread, 313 com.liferay.portal.service.ServiceContext serviceContext) 314 throws com.liferay.portal.kernel.exception.PortalException, 315 com.liferay.portal.kernel.exception.SystemException; 316 317 public void deleteThreadFlag(long threadFlagId) 318 throws com.liferay.portal.kernel.exception.PortalException, 319 com.liferay.portal.kernel.exception.SystemException; 320 321 @com.liferay.portal.kernel.systemevent.SystemEvent(type = SystemEventConstants.TYPE_DELETE) 322 public void deleteThreadFlag( 323 com.liferay.portlet.messageboards.model.MBThreadFlag threadFlag) 324 throws com.liferay.portal.kernel.exception.SystemException; 325 326 public void deleteThreadFlagsByThreadId(long threadId) 327 throws com.liferay.portal.kernel.exception.SystemException; 328 329 public void deleteThreadFlagsByUserId(long userId) 330 throws com.liferay.portal.kernel.exception.SystemException; 331 332 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 333 public com.liferay.portlet.messageboards.model.MBThreadFlag getThreadFlag( 334 long userId, com.liferay.portlet.messageboards.model.MBThread thread) 335 throws com.liferay.portal.kernel.exception.PortalException, 336 com.liferay.portal.kernel.exception.SystemException; 337 338 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 339 public boolean hasThreadFlag(long userId, 340 com.liferay.portlet.messageboards.model.MBThread thread) 341 throws com.liferay.portal.kernel.exception.PortalException, 342 com.liferay.portal.kernel.exception.SystemException; 343 }