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.journal.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; 020 import com.liferay.portal.kernel.util.ReferenceRegistry; 021 022 /** 023 * Provides the local service utility for JournalArticleResource. This utility wraps 024 * {@link com.liferay.portlet.journal.service.impl.JournalArticleResourceLocalServiceImpl} and is the 025 * primary access point for service operations in application layer code running 026 * on the local server. Methods of this service will not have security checks 027 * based on the propagated JAAS credentials because this service can only be 028 * accessed from within the same VM. 029 * 030 * @author Brian Wing Shun Chan 031 * @see JournalArticleResourceLocalService 032 * @see com.liferay.portlet.journal.service.base.JournalArticleResourceLocalServiceBaseImpl 033 * @see com.liferay.portlet.journal.service.impl.JournalArticleResourceLocalServiceImpl 034 * @generated 035 */ 036 @ProviderType 037 public class JournalArticleResourceLocalServiceUtil { 038 /* 039 * NOTE FOR DEVELOPERS: 040 * 041 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalArticleResourceLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 042 */ 043 044 /** 045 * Adds the journal article resource to the database. Also notifies the appropriate model listeners. 046 * 047 * @param journalArticleResource the journal article resource 048 * @return the journal article resource that was added 049 * @throws SystemException if a system exception occurred 050 */ 051 public static com.liferay.portlet.journal.model.JournalArticleResource addJournalArticleResource( 052 com.liferay.portlet.journal.model.JournalArticleResource journalArticleResource) 053 throws com.liferay.portal.kernel.exception.SystemException { 054 return getService().addJournalArticleResource(journalArticleResource); 055 } 056 057 /** 058 * Creates a new journal article resource with the primary key. Does not add the journal article resource to the database. 059 * 060 * @param resourcePrimKey the primary key for the new journal article resource 061 * @return the new journal article resource 062 */ 063 public static com.liferay.portlet.journal.model.JournalArticleResource createJournalArticleResource( 064 long resourcePrimKey) { 065 return getService().createJournalArticleResource(resourcePrimKey); 066 } 067 068 /** 069 * Deletes the journal article resource with the primary key from the database. Also notifies the appropriate model listeners. 070 * 071 * @param resourcePrimKey the primary key of the journal article resource 072 * @return the journal article resource that was removed 073 * @throws PortalException if a journal article resource with the primary key could not be found 074 * @throws SystemException if a system exception occurred 075 */ 076 public static com.liferay.portlet.journal.model.JournalArticleResource deleteJournalArticleResource( 077 long resourcePrimKey) 078 throws com.liferay.portal.kernel.exception.PortalException, 079 com.liferay.portal.kernel.exception.SystemException { 080 return getService().deleteJournalArticleResource(resourcePrimKey); 081 } 082 083 /** 084 * Deletes the journal article resource from the database. Also notifies the appropriate model listeners. 085 * 086 * @param journalArticleResource the journal article resource 087 * @return the journal article resource that was removed 088 * @throws SystemException if a system exception occurred 089 */ 090 public static com.liferay.portlet.journal.model.JournalArticleResource deleteJournalArticleResource( 091 com.liferay.portlet.journal.model.JournalArticleResource journalArticleResource) 092 throws com.liferay.portal.kernel.exception.SystemException { 093 return getService().deleteJournalArticleResource(journalArticleResource); 094 } 095 096 public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 097 return getService().dynamicQuery(); 098 } 099 100 /** 101 * Performs a dynamic query on the database and returns the matching rows. 102 * 103 * @param dynamicQuery the dynamic query 104 * @return the matching rows 105 * @throws SystemException if a system exception occurred 106 */ 107 @SuppressWarnings("rawtypes") 108 public static java.util.List dynamicQuery( 109 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 110 throws com.liferay.portal.kernel.exception.SystemException { 111 return getService().dynamicQuery(dynamicQuery); 112 } 113 114 /** 115 * Performs a dynamic query on the database and returns a range of the matching rows. 116 * 117 * <p> 118 * 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.journal.model.impl.JournalArticleResourceModelImpl}. 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. 119 * </p> 120 * 121 * @param dynamicQuery the dynamic query 122 * @param start the lower bound of the range of model instances 123 * @param end the upper bound of the range of model instances (not inclusive) 124 * @return the range of matching rows 125 * @throws SystemException if a system exception occurred 126 */ 127 @SuppressWarnings("rawtypes") 128 public static java.util.List dynamicQuery( 129 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 130 int end) throws com.liferay.portal.kernel.exception.SystemException { 131 return getService().dynamicQuery(dynamicQuery, start, end); 132 } 133 134 /** 135 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 136 * 137 * <p> 138 * 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.journal.model.impl.JournalArticleResourceModelImpl}. 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. 139 * </p> 140 * 141 * @param dynamicQuery the dynamic query 142 * @param start the lower bound of the range of model instances 143 * @param end the upper bound of the range of model instances (not inclusive) 144 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 145 * @return the ordered range of matching rows 146 * @throws SystemException if a system exception occurred 147 */ 148 @SuppressWarnings("rawtypes") 149 public static java.util.List dynamicQuery( 150 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 151 int end, 152 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 153 throws com.liferay.portal.kernel.exception.SystemException { 154 return getService() 155 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 156 } 157 158 /** 159 * Returns the number of rows that match the dynamic query. 160 * 161 * @param dynamicQuery the dynamic query 162 * @return the number of rows that match the dynamic query 163 * @throws SystemException if a system exception occurred 164 */ 165 public static long dynamicQueryCount( 166 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 167 throws com.liferay.portal.kernel.exception.SystemException { 168 return getService().dynamicQueryCount(dynamicQuery); 169 } 170 171 /** 172 * Returns the number of rows that match the dynamic query. 173 * 174 * @param dynamicQuery the dynamic query 175 * @param projection the projection to apply to the query 176 * @return the number of rows that match the dynamic query 177 * @throws SystemException if a system exception occurred 178 */ 179 public static long dynamicQueryCount( 180 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 181 com.liferay.portal.kernel.dao.orm.Projection projection) 182 throws com.liferay.portal.kernel.exception.SystemException { 183 return getService().dynamicQueryCount(dynamicQuery, projection); 184 } 185 186 public static com.liferay.portlet.journal.model.JournalArticleResource fetchJournalArticleResource( 187 long resourcePrimKey) 188 throws com.liferay.portal.kernel.exception.SystemException { 189 return getService().fetchJournalArticleResource(resourcePrimKey); 190 } 191 192 /** 193 * Returns the journal article resource matching the UUID and group. 194 * 195 * @param uuid the journal article resource's UUID 196 * @param groupId the primary key of the group 197 * @return the matching journal article resource, or <code>null</code> if a matching journal article resource could not be found 198 * @throws SystemException if a system exception occurred 199 */ 200 public static com.liferay.portlet.journal.model.JournalArticleResource fetchJournalArticleResourceByUuidAndGroupId( 201 java.lang.String uuid, long groupId) 202 throws com.liferay.portal.kernel.exception.SystemException { 203 return getService() 204 .fetchJournalArticleResourceByUuidAndGroupId(uuid, groupId); 205 } 206 207 /** 208 * Returns the journal article resource with the primary key. 209 * 210 * @param resourcePrimKey the primary key of the journal article resource 211 * @return the journal article resource 212 * @throws PortalException if a journal article resource with the primary key could not be found 213 * @throws SystemException if a system exception occurred 214 */ 215 public static com.liferay.portlet.journal.model.JournalArticleResource getJournalArticleResource( 216 long resourcePrimKey) 217 throws com.liferay.portal.kernel.exception.PortalException, 218 com.liferay.portal.kernel.exception.SystemException { 219 return getService().getJournalArticleResource(resourcePrimKey); 220 } 221 222 public static com.liferay.portal.model.PersistedModel getPersistedModel( 223 java.io.Serializable primaryKeyObj) 224 throws com.liferay.portal.kernel.exception.PortalException, 225 com.liferay.portal.kernel.exception.SystemException { 226 return getService().getPersistedModel(primaryKeyObj); 227 } 228 229 /** 230 * Returns the journal article resource matching the UUID and group. 231 * 232 * @param uuid the journal article resource's UUID 233 * @param groupId the primary key of the group 234 * @return the matching journal article resource 235 * @throws PortalException if a matching journal article resource could not be found 236 * @throws SystemException if a system exception occurred 237 */ 238 public static com.liferay.portlet.journal.model.JournalArticleResource getJournalArticleResourceByUuidAndGroupId( 239 java.lang.String uuid, long groupId) 240 throws com.liferay.portal.kernel.exception.PortalException, 241 com.liferay.portal.kernel.exception.SystemException { 242 return getService() 243 .getJournalArticleResourceByUuidAndGroupId(uuid, groupId); 244 } 245 246 /** 247 * Returns a range of all the journal article resources. 248 * 249 * <p> 250 * 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.journal.model.impl.JournalArticleResourceModelImpl}. 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. 251 * </p> 252 * 253 * @param start the lower bound of the range of journal article resources 254 * @param end the upper bound of the range of journal article resources (not inclusive) 255 * @return the range of journal article resources 256 * @throws SystemException if a system exception occurred 257 */ 258 public static java.util.List<com.liferay.portlet.journal.model.JournalArticleResource> getJournalArticleResources( 259 int start, int end) 260 throws com.liferay.portal.kernel.exception.SystemException { 261 return getService().getJournalArticleResources(start, end); 262 } 263 264 /** 265 * Returns the number of journal article resources. 266 * 267 * @return the number of journal article resources 268 * @throws SystemException if a system exception occurred 269 */ 270 public static int getJournalArticleResourcesCount() 271 throws com.liferay.portal.kernel.exception.SystemException { 272 return getService().getJournalArticleResourcesCount(); 273 } 274 275 /** 276 * Updates the journal article resource in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 277 * 278 * @param journalArticleResource the journal article resource 279 * @return the journal article resource that was updated 280 * @throws SystemException if a system exception occurred 281 */ 282 public static com.liferay.portlet.journal.model.JournalArticleResource updateJournalArticleResource( 283 com.liferay.portlet.journal.model.JournalArticleResource journalArticleResource) 284 throws com.liferay.portal.kernel.exception.SystemException { 285 return getService().updateJournalArticleResource(journalArticleResource); 286 } 287 288 /** 289 * Returns the Spring bean ID for this bean. 290 * 291 * @return the Spring bean ID for this bean 292 */ 293 public static java.lang.String getBeanIdentifier() { 294 return getService().getBeanIdentifier(); 295 } 296 297 /** 298 * Sets the Spring bean ID for this bean. 299 * 300 * @param beanIdentifier the Spring bean ID for this bean 301 */ 302 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 303 getService().setBeanIdentifier(beanIdentifier); 304 } 305 306 public static void deleteArticleResource(long groupId, 307 java.lang.String articleId) 308 throws com.liferay.portal.kernel.exception.PortalException, 309 com.liferay.portal.kernel.exception.SystemException { 310 getService().deleteArticleResource(groupId, articleId); 311 } 312 313 public static com.liferay.portlet.journal.model.JournalArticleResource fetchArticleResource( 314 long groupId, java.lang.String articleId) 315 throws com.liferay.portal.kernel.exception.SystemException { 316 return getService().fetchArticleResource(groupId, articleId); 317 } 318 319 public static com.liferay.portlet.journal.model.JournalArticleResource fetchArticleResource( 320 java.lang.String uuid, long groupId) 321 throws com.liferay.portal.kernel.exception.SystemException { 322 return getService().fetchArticleResource(uuid, groupId); 323 } 324 325 public static com.liferay.portlet.journal.model.JournalArticleResource getArticleResource( 326 long articleResourcePrimKey) 327 throws com.liferay.portal.kernel.exception.PortalException, 328 com.liferay.portal.kernel.exception.SystemException { 329 return getService().getArticleResource(articleResourcePrimKey); 330 } 331 332 public static long getArticleResourcePrimKey(long groupId, 333 java.lang.String articleId) 334 throws com.liferay.portal.kernel.exception.SystemException { 335 return getService().getArticleResourcePrimKey(groupId, articleId); 336 } 337 338 public static long getArticleResourcePrimKey(java.lang.String uuid, 339 long groupId, java.lang.String articleId) 340 throws com.liferay.portal.kernel.exception.SystemException { 341 return getService().getArticleResourcePrimKey(uuid, groupId, articleId); 342 } 343 344 public static java.util.List<com.liferay.portlet.journal.model.JournalArticleResource> getArticleResources( 345 long groupId) 346 throws com.liferay.portal.kernel.exception.SystemException { 347 return getService().getArticleResources(groupId); 348 } 349 350 public static JournalArticleResourceLocalService getService() { 351 if (_service == null) { 352 _service = (JournalArticleResourceLocalService)PortalBeanLocatorUtil.locate(JournalArticleResourceLocalService.class.getName()); 353 354 ReferenceRegistry.registerReference(JournalArticleResourceLocalServiceUtil.class, 355 "_service"); 356 } 357 358 return _service; 359 } 360 361 /** 362 * @deprecated As of 6.2.0 363 */ 364 public void setService(JournalArticleResourceLocalService service) { 365 } 366 367 private static JournalArticleResourceLocalService _service; 368 }