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 com.liferay.portal.kernel.exception.PortalException; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.kernel.transaction.Isolation; 020 import com.liferay.portal.kernel.transaction.Propagation; 021 import com.liferay.portal.kernel.transaction.Transactional; 022 import com.liferay.portal.service.BaseLocalService; 023 import com.liferay.portal.service.PersistedModelLocalService; 024 025 /** 026 * The interface for the message boards thread flag local service. 027 * 028 * <p> 029 * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM. 030 * </p> 031 * 032 * @author Brian Wing Shun Chan 033 * @see MBThreadFlagLocalServiceUtil 034 * @see com.liferay.portlet.messageboards.service.base.MBThreadFlagLocalServiceBaseImpl 035 * @see com.liferay.portlet.messageboards.service.impl.MBThreadFlagLocalServiceImpl 036 * @generated 037 */ 038 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 039 PortalException.class, SystemException.class}) 040 public interface MBThreadFlagLocalService extends BaseLocalService, 041 PersistedModelLocalService { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * 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. 046 */ 047 048 /** 049 * Adds the message boards thread flag to the database. Also notifies the appropriate model listeners. 050 * 051 * @param mbThreadFlag the message boards thread flag 052 * @return the message boards thread flag that was added 053 * @throws SystemException if a system exception occurred 054 */ 055 public com.liferay.portlet.messageboards.model.MBThreadFlag addMBThreadFlag( 056 com.liferay.portlet.messageboards.model.MBThreadFlag mbThreadFlag) 057 throws com.liferay.portal.kernel.exception.SystemException; 058 059 /** 060 * Creates a new message boards thread flag with the primary key. Does not add the message boards thread flag to the database. 061 * 062 * @param threadFlagId the primary key for the new message boards thread flag 063 * @return the new message boards thread flag 064 */ 065 public com.liferay.portlet.messageboards.model.MBThreadFlag createMBThreadFlag( 066 long threadFlagId); 067 068 /** 069 * Deletes the message boards thread flag with the primary key from the database. Also notifies the appropriate model listeners. 070 * 071 * @param threadFlagId the primary key of the message boards thread flag 072 * @return the message boards thread flag that was removed 073 * @throws PortalException if a message boards thread flag with the primary key could not be found 074 * @throws SystemException if a system exception occurred 075 */ 076 public com.liferay.portlet.messageboards.model.MBThreadFlag deleteMBThreadFlag( 077 long threadFlagId) 078 throws com.liferay.portal.kernel.exception.PortalException, 079 com.liferay.portal.kernel.exception.SystemException; 080 081 /** 082 * Deletes the message boards thread flag from the database. Also notifies the appropriate model listeners. 083 * 084 * @param mbThreadFlag the message boards thread flag 085 * @return the message boards thread flag that was removed 086 * @throws SystemException if a system exception occurred 087 */ 088 public com.liferay.portlet.messageboards.model.MBThreadFlag deleteMBThreadFlag( 089 com.liferay.portlet.messageboards.model.MBThreadFlag mbThreadFlag) 090 throws com.liferay.portal.kernel.exception.SystemException; 091 092 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 093 094 /** 095 * Performs a dynamic query on the database and returns the matching rows. 096 * 097 * @param dynamicQuery the dynamic query 098 * @return the matching rows 099 * @throws SystemException if a system exception occurred 100 */ 101 @SuppressWarnings("rawtypes") 102 public java.util.List dynamicQuery( 103 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 104 throws com.liferay.portal.kernel.exception.SystemException; 105 106 /** 107 * Performs a dynamic query on the database and returns a range of the matching rows. 108 * 109 * <p> 110 * 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. 111 * </p> 112 * 113 * @param dynamicQuery the dynamic query 114 * @param start the lower bound of the range of model instances 115 * @param end the upper bound of the range of model instances (not inclusive) 116 * @return the range of matching rows 117 * @throws SystemException if a system exception occurred 118 */ 119 @SuppressWarnings("rawtypes") 120 public java.util.List dynamicQuery( 121 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 122 int end) throws com.liferay.portal.kernel.exception.SystemException; 123 124 /** 125 * Performs a dynamic query on the database and returns an ordered 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. 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 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 135 * @return the ordered range of matching rows 136 * @throws SystemException if a system exception occurred 137 */ 138 @SuppressWarnings("rawtypes") 139 public java.util.List dynamicQuery( 140 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 141 int end, 142 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 143 throws com.liferay.portal.kernel.exception.SystemException; 144 145 /** 146 * Returns the number of rows that match the dynamic query. 147 * 148 * @param dynamicQuery the dynamic query 149 * @return the number of rows that match the dynamic query 150 * @throws SystemException if a system exception occurred 151 */ 152 public long dynamicQueryCount( 153 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 154 throws com.liferay.portal.kernel.exception.SystemException; 155 156 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 157 public com.liferay.portlet.messageboards.model.MBThreadFlag fetchMBThreadFlag( 158 long threadFlagId) 159 throws com.liferay.portal.kernel.exception.SystemException; 160 161 /** 162 * Returns the message boards thread flag with the primary key. 163 * 164 * @param threadFlagId the primary key of the message boards thread flag 165 * @return the message boards thread flag 166 * @throws PortalException if a message boards thread flag with the primary key could not be found 167 * @throws SystemException if a system exception occurred 168 */ 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public com.liferay.portlet.messageboards.model.MBThreadFlag getMBThreadFlag( 171 long threadFlagId) 172 throws com.liferay.portal.kernel.exception.PortalException, 173 com.liferay.portal.kernel.exception.SystemException; 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portal.model.PersistedModel getPersistedModel( 177 java.io.Serializable primaryKeyObj) 178 throws com.liferay.portal.kernel.exception.PortalException, 179 com.liferay.portal.kernel.exception.SystemException; 180 181 /** 182 * Returns a range of all the message boards thread flags. 183 * 184 * <p> 185 * 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. 186 * </p> 187 * 188 * @param start the lower bound of the range of message boards thread flags 189 * @param end the upper bound of the range of message boards thread flags (not inclusive) 190 * @return the range of message boards thread flags 191 * @throws SystemException if a system exception occurred 192 */ 193 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 194 public java.util.List<com.liferay.portlet.messageboards.model.MBThreadFlag> getMBThreadFlags( 195 int start, int end) 196 throws com.liferay.portal.kernel.exception.SystemException; 197 198 /** 199 * Returns the number of message boards thread flags. 200 * 201 * @return the number of message boards thread flags 202 * @throws SystemException if a system exception occurred 203 */ 204 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 205 public int getMBThreadFlagsCount() 206 throws com.liferay.portal.kernel.exception.SystemException; 207 208 /** 209 * Updates the message boards thread flag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 210 * 211 * @param mbThreadFlag the message boards thread flag 212 * @return the message boards thread flag that was updated 213 * @throws SystemException if a system exception occurred 214 */ 215 public com.liferay.portlet.messageboards.model.MBThreadFlag updateMBThreadFlag( 216 com.liferay.portlet.messageboards.model.MBThreadFlag mbThreadFlag) 217 throws com.liferay.portal.kernel.exception.SystemException; 218 219 /** 220 * Updates the message boards thread flag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 221 * 222 * @param mbThreadFlag the message boards thread flag 223 * @param merge whether to merge the message boards thread flag with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation. 224 * @return the message boards thread flag that was updated 225 * @throws SystemException if a system exception occurred 226 */ 227 public com.liferay.portlet.messageboards.model.MBThreadFlag updateMBThreadFlag( 228 com.liferay.portlet.messageboards.model.MBThreadFlag mbThreadFlag, 229 boolean merge) 230 throws com.liferay.portal.kernel.exception.SystemException; 231 232 /** 233 * Returns the Spring bean ID for this bean. 234 * 235 * @return the Spring bean ID for this bean 236 */ 237 public java.lang.String getBeanIdentifier(); 238 239 /** 240 * Sets the Spring bean ID for this bean. 241 * 242 * @param beanIdentifier the Spring bean ID for this bean 243 */ 244 public void setBeanIdentifier(java.lang.String beanIdentifier); 245 246 public void addThreadFlag(long userId, 247 com.liferay.portlet.messageboards.model.MBThread thread) 248 throws com.liferay.portal.kernel.exception.PortalException, 249 com.liferay.portal.kernel.exception.SystemException; 250 251 public void deleteThreadFlag(long threadFlagId) 252 throws com.liferay.portal.kernel.exception.PortalException, 253 com.liferay.portal.kernel.exception.SystemException; 254 255 public void deleteThreadFlag( 256 com.liferay.portlet.messageboards.model.MBThreadFlag threadFlag) 257 throws com.liferay.portal.kernel.exception.SystemException; 258 259 public void deleteThreadFlagsByThreadId(long threadId) 260 throws com.liferay.portal.kernel.exception.SystemException; 261 262 public void deleteThreadFlagsByUserId(long userId) 263 throws com.liferay.portal.kernel.exception.SystemException; 264 265 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 266 public com.liferay.portlet.messageboards.model.MBThreadFlag getThreadFlag( 267 long userId, com.liferay.portlet.messageboards.model.MBThread thread) 268 throws com.liferay.portal.kernel.exception.PortalException, 269 com.liferay.portal.kernel.exception.SystemException; 270 271 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 272 public boolean hasThreadFlag(long userId, 273 com.liferay.portlet.messageboards.model.MBThread thread) 274 throws com.liferay.portal.kernel.exception.PortalException, 275 com.liferay.portal.kernel.exception.SystemException; 276 }