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