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