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