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