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.bean.PortalBeanLocatorUtil; 018 import com.liferay.portal.kernel.util.ReferenceRegistry; 019 020 /** 021 * Provides the local service utility for AnnouncementsFlag. This utility wraps 022 * {@link com.liferay.portlet.announcements.service.impl.AnnouncementsFlagLocalServiceImpl} and is the 023 * primary access point for service operations in application layer code running 024 * on the local server. Methods of this service will not have security checks 025 * based on the propagated JAAS credentials because this service can only be 026 * accessed from within the same VM. 027 * 028 * @author Brian Wing Shun Chan 029 * @see AnnouncementsFlagLocalService 030 * @see com.liferay.portlet.announcements.service.base.AnnouncementsFlagLocalServiceBaseImpl 031 * @see com.liferay.portlet.announcements.service.impl.AnnouncementsFlagLocalServiceImpl 032 * @generated 033 */ 034 public class AnnouncementsFlagLocalServiceUtil { 035 /* 036 * NOTE FOR DEVELOPERS: 037 * 038 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.announcements.service.impl.AnnouncementsFlagLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 039 */ 040 041 /** 042 * Adds the announcements flag to the database. Also notifies the appropriate model listeners. 043 * 044 * @param announcementsFlag the announcements flag 045 * @return the announcements flag that was added 046 * @throws SystemException if a system exception occurred 047 */ 048 public static com.liferay.portlet.announcements.model.AnnouncementsFlag addAnnouncementsFlag( 049 com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag) 050 throws com.liferay.portal.kernel.exception.SystemException { 051 return getService().addAnnouncementsFlag(announcementsFlag); 052 } 053 054 /** 055 * Creates a new announcements flag with the primary key. Does not add the announcements flag to the database. 056 * 057 * @param flagId the primary key for the new announcements flag 058 * @return the new announcements flag 059 */ 060 public static com.liferay.portlet.announcements.model.AnnouncementsFlag createAnnouncementsFlag( 061 long flagId) { 062 return getService().createAnnouncementsFlag(flagId); 063 } 064 065 /** 066 * Deletes the announcements flag with the primary key from the database. Also notifies the appropriate model listeners. 067 * 068 * @param flagId the primary key of the announcements flag 069 * @return the announcements flag that was removed 070 * @throws PortalException if a announcements flag with the primary key could not be found 071 * @throws SystemException if a system exception occurred 072 */ 073 public static com.liferay.portlet.announcements.model.AnnouncementsFlag deleteAnnouncementsFlag( 074 long flagId) 075 throws com.liferay.portal.kernel.exception.PortalException, 076 com.liferay.portal.kernel.exception.SystemException { 077 return getService().deleteAnnouncementsFlag(flagId); 078 } 079 080 /** 081 * Deletes the announcements flag from the database. Also notifies the appropriate model listeners. 082 * 083 * @param announcementsFlag the announcements flag 084 * @return the announcements flag that was removed 085 * @throws SystemException if a system exception occurred 086 */ 087 public static com.liferay.portlet.announcements.model.AnnouncementsFlag deleteAnnouncementsFlag( 088 com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag) 089 throws com.liferay.portal.kernel.exception.SystemException { 090 return getService().deleteAnnouncementsFlag(announcementsFlag); 091 } 092 093 public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 094 return getService().dynamicQuery(); 095 } 096 097 /** 098 * Performs a dynamic query on the database and returns the matching rows. 099 * 100 * @param dynamicQuery the dynamic query 101 * @return the matching rows 102 * @throws SystemException if a system exception occurred 103 */ 104 @SuppressWarnings("rawtypes") 105 public static java.util.List dynamicQuery( 106 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 107 throws com.liferay.portal.kernel.exception.SystemException { 108 return getService().dynamicQuery(dynamicQuery); 109 } 110 111 /** 112 * Performs a dynamic query on the database and returns a range of the matching rows. 113 * 114 * <p> 115 * 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. 116 * </p> 117 * 118 * @param dynamicQuery the dynamic query 119 * @param start the lower bound of the range of model instances 120 * @param end the upper bound of the range of model instances (not inclusive) 121 * @return the range of matching rows 122 * @throws SystemException if a system exception occurred 123 */ 124 @SuppressWarnings("rawtypes") 125 public static java.util.List dynamicQuery( 126 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 127 int end) throws com.liferay.portal.kernel.exception.SystemException { 128 return getService().dynamicQuery(dynamicQuery, start, end); 129 } 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.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. 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 static 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 return getService() 152 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 153 } 154 155 /** 156 * Returns the number of rows that match the dynamic query. 157 * 158 * @param dynamicQuery the dynamic query 159 * @return the number of rows that match the dynamic query 160 * @throws SystemException if a system exception occurred 161 */ 162 public static long dynamicQueryCount( 163 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 164 throws com.liferay.portal.kernel.exception.SystemException { 165 return getService().dynamicQueryCount(dynamicQuery); 166 } 167 168 /** 169 * Returns the number of rows that match the dynamic query. 170 * 171 * @param dynamicQuery the dynamic query 172 * @param projection the projection to apply to the query 173 * @return the number of rows that match the dynamic query 174 * @throws SystemException if a system exception occurred 175 */ 176 public static long dynamicQueryCount( 177 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 178 com.liferay.portal.kernel.dao.orm.Projection projection) 179 throws com.liferay.portal.kernel.exception.SystemException { 180 return getService().dynamicQueryCount(dynamicQuery, projection); 181 } 182 183 public static com.liferay.portlet.announcements.model.AnnouncementsFlag fetchAnnouncementsFlag( 184 long flagId) throws com.liferay.portal.kernel.exception.SystemException { 185 return getService().fetchAnnouncementsFlag(flagId); 186 } 187 188 /** 189 * Returns the announcements flag with the primary key. 190 * 191 * @param flagId the primary key of the announcements flag 192 * @return the announcements flag 193 * @throws PortalException if a announcements flag with the primary key could not be found 194 * @throws SystemException if a system exception occurred 195 */ 196 public static com.liferay.portlet.announcements.model.AnnouncementsFlag getAnnouncementsFlag( 197 long flagId) 198 throws com.liferay.portal.kernel.exception.PortalException, 199 com.liferay.portal.kernel.exception.SystemException { 200 return getService().getAnnouncementsFlag(flagId); 201 } 202 203 public static com.liferay.portal.model.PersistedModel getPersistedModel( 204 java.io.Serializable primaryKeyObj) 205 throws com.liferay.portal.kernel.exception.PortalException, 206 com.liferay.portal.kernel.exception.SystemException { 207 return getService().getPersistedModel(primaryKeyObj); 208 } 209 210 /** 211 * Returns a range of all the announcements flags. 212 * 213 * <p> 214 * 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. 215 * </p> 216 * 217 * @param start the lower bound of the range of announcements flags 218 * @param end the upper bound of the range of announcements flags (not inclusive) 219 * @return the range of announcements flags 220 * @throws SystemException if a system exception occurred 221 */ 222 public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsFlag> getAnnouncementsFlags( 223 int start, int end) 224 throws com.liferay.portal.kernel.exception.SystemException { 225 return getService().getAnnouncementsFlags(start, end); 226 } 227 228 /** 229 * Returns the number of announcements flags. 230 * 231 * @return the number of announcements flags 232 * @throws SystemException if a system exception occurred 233 */ 234 public static int getAnnouncementsFlagsCount() 235 throws com.liferay.portal.kernel.exception.SystemException { 236 return getService().getAnnouncementsFlagsCount(); 237 } 238 239 /** 240 * Updates the announcements flag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 241 * 242 * @param announcementsFlag the announcements flag 243 * @return the announcements flag that was updated 244 * @throws SystemException if a system exception occurred 245 */ 246 public static com.liferay.portlet.announcements.model.AnnouncementsFlag updateAnnouncementsFlag( 247 com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag) 248 throws com.liferay.portal.kernel.exception.SystemException { 249 return getService().updateAnnouncementsFlag(announcementsFlag); 250 } 251 252 /** 253 * Returns the Spring bean ID for this bean. 254 * 255 * @return the Spring bean ID for this bean 256 */ 257 public static java.lang.String getBeanIdentifier() { 258 return getService().getBeanIdentifier(); 259 } 260 261 /** 262 * Sets the Spring bean ID for this bean. 263 * 264 * @param beanIdentifier the Spring bean ID for this bean 265 */ 266 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 267 getService().setBeanIdentifier(beanIdentifier); 268 } 269 270 public static com.liferay.portlet.announcements.model.AnnouncementsFlag addFlag( 271 long userId, long entryId, int value) 272 throws com.liferay.portal.kernel.exception.SystemException { 273 return getService().addFlag(userId, entryId, value); 274 } 275 276 public static void deleteFlag( 277 com.liferay.portlet.announcements.model.AnnouncementsFlag flag) 278 throws com.liferay.portal.kernel.exception.SystemException { 279 getService().deleteFlag(flag); 280 } 281 282 public static void deleteFlag(long flagId) 283 throws com.liferay.portal.kernel.exception.PortalException, 284 com.liferay.portal.kernel.exception.SystemException { 285 getService().deleteFlag(flagId); 286 } 287 288 public static void deleteFlags(long entryId) 289 throws com.liferay.portal.kernel.exception.SystemException { 290 getService().deleteFlags(entryId); 291 } 292 293 public static com.liferay.portlet.announcements.model.AnnouncementsFlag getFlag( 294 long userId, long entryId, int value) 295 throws com.liferay.portal.kernel.exception.PortalException, 296 com.liferay.portal.kernel.exception.SystemException { 297 return getService().getFlag(userId, entryId, value); 298 } 299 300 public static AnnouncementsFlagLocalService getService() { 301 if (_service == null) { 302 _service = (AnnouncementsFlagLocalService)PortalBeanLocatorUtil.locate(AnnouncementsFlagLocalService.class.getName()); 303 304 ReferenceRegistry.registerReference(AnnouncementsFlagLocalServiceUtil.class, 305 "_service"); 306 } 307 308 return _service; 309 } 310 311 /** 312 * @deprecated As of 6.2.0 313 */ 314 public void setService(AnnouncementsFlagLocalService service) { 315 } 316 317 private static AnnouncementsFlagLocalService _service; 318 }