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.announcements.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 AnnouncementsFlag. 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 AnnouncementsFlagLocalServiceUtil 036 * @see com.liferay.portlet.announcements.service.base.AnnouncementsFlagLocalServiceBaseImpl 037 * @see com.liferay.portlet.announcements.service.impl.AnnouncementsFlagLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface AnnouncementsFlagLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * 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. 049 */ 050 051 /** 052 * Adds the announcements flag to the database. Also notifies the appropriate model listeners. 053 * 054 * @param announcementsFlag the announcements flag 055 * @return the announcements flag that was added 056 */ 057 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 058 public com.liferay.portlet.announcements.model.AnnouncementsFlag addAnnouncementsFlag( 059 com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag); 060 061 public com.liferay.portlet.announcements.model.AnnouncementsFlag addFlag( 062 long userId, long entryId, int value); 063 064 /** 065 * Creates a new announcements flag with the primary key. Does not add the announcements flag to the database. 066 * 067 * @param flagId the primary key for the new announcements flag 068 * @return the new announcements flag 069 */ 070 public com.liferay.portlet.announcements.model.AnnouncementsFlag createAnnouncementsFlag( 071 long flagId); 072 073 /** 074 * Deletes the announcements flag from the database. Also notifies the appropriate model listeners. 075 * 076 * @param announcementsFlag the announcements flag 077 * @return the announcements flag that was removed 078 */ 079 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 080 public com.liferay.portlet.announcements.model.AnnouncementsFlag deleteAnnouncementsFlag( 081 com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag); 082 083 /** 084 * Deletes the announcements flag with the primary key from the database. Also notifies the appropriate model listeners. 085 * 086 * @param flagId the primary key of the announcements flag 087 * @return the announcements flag that was removed 088 * @throws PortalException if a announcements flag with the primary key could not be found 089 */ 090 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 091 public com.liferay.portlet.announcements.model.AnnouncementsFlag deleteAnnouncementsFlag( 092 long flagId) throws com.liferay.portal.kernel.exception.PortalException; 093 094 public void deleteFlag( 095 com.liferay.portlet.announcements.model.AnnouncementsFlag flag); 096 097 public void deleteFlag(long flagId) 098 throws com.liferay.portal.kernel.exception.PortalException; 099 100 public void deleteFlags(long entryId); 101 102 /** 103 * @throws PortalException 104 */ 105 @Override 106 public com.liferay.portal.model.PersistedModel deletePersistedModel( 107 com.liferay.portal.model.PersistedModel persistedModel) 108 throws com.liferay.portal.kernel.exception.PortalException; 109 110 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 111 112 /** 113 * Performs a dynamic query on the database and returns the matching rows. 114 * 115 * @param dynamicQuery the dynamic query 116 * @return the matching rows 117 */ 118 public <T> java.util.List<T> dynamicQuery( 119 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 120 121 /** 122 * Performs a dynamic query on the database and returns a range of the matching rows. 123 * 124 * <p> 125 * 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.announcements.model.impl.AnnouncementsFlagModelImpl}. 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. 126 * </p> 127 * 128 * @param dynamicQuery the dynamic query 129 * @param start the lower bound of the range of model instances 130 * @param end the upper bound of the range of model instances (not inclusive) 131 * @return the range of matching rows 132 */ 133 public <T> java.util.List<T> dynamicQuery( 134 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 135 int end); 136 137 /** 138 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 139 * 140 * <p> 141 * 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.announcements.model.impl.AnnouncementsFlagModelImpl}. 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. 142 * </p> 143 * 144 * @param dynamicQuery the dynamic query 145 * @param start the lower bound of the range of model instances 146 * @param end the upper bound of the range of model instances (not inclusive) 147 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 148 * @return the ordered range of matching rows 149 */ 150 public <T> java.util.List<T> dynamicQuery( 151 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 152 int end, 153 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 154 155 /** 156 * Returns the number of rows matching the dynamic query. 157 * 158 * @param dynamicQuery the dynamic query 159 * @return the number of rows matching the dynamic query 160 */ 161 public long dynamicQueryCount( 162 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 163 164 /** 165 * Returns the number of rows matching the dynamic query. 166 * 167 * @param dynamicQuery the dynamic query 168 * @param projection the projection to apply to the query 169 * @return the number of rows matching the dynamic query 170 */ 171 public long dynamicQueryCount( 172 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 173 com.liferay.portal.kernel.dao.orm.Projection projection); 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portlet.announcements.model.AnnouncementsFlag fetchAnnouncementsFlag( 177 long flagId); 178 179 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 180 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 181 182 /** 183 * Returns the announcements flag with the primary key. 184 * 185 * @param flagId the primary key of the announcements flag 186 * @return the announcements flag 187 * @throws PortalException if a announcements flag with the primary key could not be found 188 */ 189 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 190 public com.liferay.portlet.announcements.model.AnnouncementsFlag getAnnouncementsFlag( 191 long flagId) throws com.liferay.portal.kernel.exception.PortalException; 192 193 /** 194 * Returns a range of all the announcements flags. 195 * 196 * <p> 197 * 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.announcements.model.impl.AnnouncementsFlagModelImpl}. 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. 198 * </p> 199 * 200 * @param start the lower bound of the range of announcements flags 201 * @param end the upper bound of the range of announcements flags (not inclusive) 202 * @return the range of announcements flags 203 */ 204 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 205 public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsFlag> getAnnouncementsFlags( 206 int start, int end); 207 208 /** 209 * Returns the number of announcements flags. 210 * 211 * @return the number of announcements flags 212 */ 213 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 214 public int getAnnouncementsFlagsCount(); 215 216 /** 217 * Returns the Spring bean ID for this bean. 218 * 219 * @return the Spring bean ID for this bean 220 */ 221 public java.lang.String getBeanIdentifier(); 222 223 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 224 public com.liferay.portlet.announcements.model.AnnouncementsFlag getFlag( 225 long userId, long entryId, int value) 226 throws com.liferay.portal.kernel.exception.PortalException; 227 228 @Override 229 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 230 public com.liferay.portal.model.PersistedModel getPersistedModel( 231 java.io.Serializable primaryKeyObj) 232 throws com.liferay.portal.kernel.exception.PortalException; 233 234 /** 235 * Sets the Spring bean ID for this bean. 236 * 237 * @param beanIdentifier the Spring bean ID for this bean 238 */ 239 public void setBeanIdentifier(java.lang.String beanIdentifier); 240 241 /** 242 * Updates the announcements flag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 243 * 244 * @param announcementsFlag the announcements flag 245 * @return the announcements flag that was updated 246 */ 247 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 248 public com.liferay.portlet.announcements.model.AnnouncementsFlag updateAnnouncementsFlag( 249 com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag); 250 }