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.announcements.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 announcements 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 AnnouncementsFlagLocalServiceUtil 034 * @see com.liferay.portlet.announcements.service.base.AnnouncementsFlagLocalServiceBaseImpl 035 * @see com.liferay.portlet.announcements.service.impl.AnnouncementsFlagLocalServiceImpl 036 * @generated 037 */ 038 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 039 PortalException.class, SystemException.class}) 040 public interface AnnouncementsFlagLocalService extends BaseLocalService, 041 PersistedModelLocalService { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. Always use {@link AnnouncementsFlagLocalServiceUtil} to access the announcements flag local service. Add custom service methods to {@link com.liferay.portlet.announcements.service.impl.AnnouncementsFlagLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 046 */ 047 048 /** 049 * Adds the announcements flag to the database. Also notifies the appropriate model listeners. 050 * 051 * @param announcementsFlag the announcements flag 052 * @return the announcements flag that was added 053 * @throws SystemException if a system exception occurred 054 */ 055 public com.liferay.portlet.announcements.model.AnnouncementsFlag addAnnouncementsFlag( 056 com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag) 057 throws com.liferay.portal.kernel.exception.SystemException; 058 059 /** 060 * Creates a new announcements flag with the primary key. Does not add the announcements flag to the database. 061 * 062 * @param flagId the primary key for the new announcements flag 063 * @return the new announcements flag 064 */ 065 public com.liferay.portlet.announcements.model.AnnouncementsFlag createAnnouncementsFlag( 066 long flagId); 067 068 /** 069 * Deletes the announcements flag with the primary key from the database. Also notifies the appropriate model listeners. 070 * 071 * @param flagId the primary key of the announcements flag 072 * @return the announcements flag that was removed 073 * @throws PortalException if a announcements flag with the primary key could not be found 074 * @throws SystemException if a system exception occurred 075 */ 076 public com.liferay.portlet.announcements.model.AnnouncementsFlag deleteAnnouncementsFlag( 077 long flagId) 078 throws com.liferay.portal.kernel.exception.PortalException, 079 com.liferay.portal.kernel.exception.SystemException; 080 081 /** 082 * Deletes the announcements flag from the database. Also notifies the appropriate model listeners. 083 * 084 * @param announcementsFlag the announcements flag 085 * @return the announcements flag that was removed 086 * @throws SystemException if a system exception occurred 087 */ 088 public com.liferay.portlet.announcements.model.AnnouncementsFlag deleteAnnouncementsFlag( 089 com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag) 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.announcements.model.AnnouncementsFlag fetchAnnouncementsFlag( 158 long flagId) throws com.liferay.portal.kernel.exception.SystemException; 159 160 /** 161 * Returns the announcements flag with the primary key. 162 * 163 * @param flagId the primary key of the announcements flag 164 * @return the announcements flag 165 * @throws PortalException if a announcements flag with the primary key could not be found 166 * @throws SystemException if a system exception occurred 167 */ 168 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 169 public com.liferay.portlet.announcements.model.AnnouncementsFlag getAnnouncementsFlag( 170 long flagId) 171 throws com.liferay.portal.kernel.exception.PortalException, 172 com.liferay.portal.kernel.exception.SystemException; 173 174 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 175 public com.liferay.portal.model.PersistedModel getPersistedModel( 176 java.io.Serializable primaryKeyObj) 177 throws com.liferay.portal.kernel.exception.PortalException, 178 com.liferay.portal.kernel.exception.SystemException; 179 180 /** 181 * Returns a range of all the announcements flags. 182 * 183 * <p> 184 * 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. 185 * </p> 186 * 187 * @param start the lower bound of the range of announcements flags 188 * @param end the upper bound of the range of announcements flags (not inclusive) 189 * @return the range of announcements flags 190 * @throws SystemException if a system exception occurred 191 */ 192 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 193 public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsFlag> getAnnouncementsFlags( 194 int start, int end) 195 throws com.liferay.portal.kernel.exception.SystemException; 196 197 /** 198 * Returns the number of announcements flags. 199 * 200 * @return the number of announcements flags 201 * @throws SystemException if a system exception occurred 202 */ 203 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 204 public int getAnnouncementsFlagsCount() 205 throws com.liferay.portal.kernel.exception.SystemException; 206 207 /** 208 * Updates the announcements flag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 209 * 210 * @param announcementsFlag the announcements flag 211 * @return the announcements flag that was updated 212 * @throws SystemException if a system exception occurred 213 */ 214 public com.liferay.portlet.announcements.model.AnnouncementsFlag updateAnnouncementsFlag( 215 com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag) 216 throws com.liferay.portal.kernel.exception.SystemException; 217 218 /** 219 * Updates the announcements flag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 220 * 221 * @param announcementsFlag the announcements flag 222 * @param merge whether to merge the announcements 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. 223 * @return the announcements flag that was updated 224 * @throws SystemException if a system exception occurred 225 */ 226 public com.liferay.portlet.announcements.model.AnnouncementsFlag updateAnnouncementsFlag( 227 com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag, 228 boolean merge) 229 throws com.liferay.portal.kernel.exception.SystemException; 230 231 /** 232 * Returns the Spring bean ID for this bean. 233 * 234 * @return the Spring bean ID for this bean 235 */ 236 public java.lang.String getBeanIdentifier(); 237 238 /** 239 * Sets the Spring bean ID for this bean. 240 * 241 * @param beanIdentifier the Spring bean ID for this bean 242 */ 243 public void setBeanIdentifier(java.lang.String beanIdentifier); 244 245 public com.liferay.portlet.announcements.model.AnnouncementsFlag addFlag( 246 long userId, long entryId, int value) 247 throws com.liferay.portal.kernel.exception.SystemException; 248 249 public void deleteFlag( 250 com.liferay.portlet.announcements.model.AnnouncementsFlag flag) 251 throws com.liferay.portal.kernel.exception.SystemException; 252 253 public void deleteFlag(long flagId) 254 throws com.liferay.portal.kernel.exception.PortalException, 255 com.liferay.portal.kernel.exception.SystemException; 256 257 public void deleteFlags(long entryId) 258 throws com.liferay.portal.kernel.exception.SystemException; 259 260 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 261 public com.liferay.portlet.announcements.model.AnnouncementsFlag getFlag( 262 long userId, long entryId, int value) 263 throws com.liferay.portal.kernel.exception.PortalException, 264 com.liferay.portal.kernel.exception.SystemException; 265 }