001 /** 002 * Copyright (c) 2000-present 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 */ 057 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 058 public com.liferay.portlet.journal.model.JournalArticleResource addJournalArticleResource( 059 com.liferay.portlet.journal.model.JournalArticleResource journalArticleResource); 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 public void deleteArticleResource(long groupId, java.lang.String articleId) 071 throws PortalException; 072 073 /** 074 * Deletes the journal article resource from the database. Also notifies the appropriate model listeners. 075 * 076 * @param journalArticleResource the journal article resource 077 * @return the journal article resource that was removed 078 */ 079 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 080 public com.liferay.portlet.journal.model.JournalArticleResource deleteJournalArticleResource( 081 com.liferay.portlet.journal.model.JournalArticleResource journalArticleResource); 082 083 /** 084 * Deletes the journal article resource with the primary key from the database. Also notifies the appropriate model listeners. 085 * 086 * @param resourcePrimKey the primary key of the journal article resource 087 * @return the journal article resource that was removed 088 * @throws PortalException if a journal article resource with the primary key could not be found 089 */ 090 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 091 public com.liferay.portlet.journal.model.JournalArticleResource deleteJournalArticleResource( 092 long resourcePrimKey) throws PortalException; 093 094 /** 095 * @throws PortalException 096 */ 097 @Override 098 public com.liferay.portal.model.PersistedModel deletePersistedModel( 099 com.liferay.portal.model.PersistedModel persistedModel) 100 throws PortalException; 101 102 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 103 104 /** 105 * Performs a dynamic query on the database and returns the matching rows. 106 * 107 * @param dynamicQuery the dynamic query 108 * @return the matching rows 109 */ 110 public <T> java.util.List<T> dynamicQuery( 111 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 112 113 /** 114 * Performs a dynamic query on the database and returns a range of the matching rows. 115 * 116 * <p> 117 * 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. 118 * </p> 119 * 120 * @param dynamicQuery the dynamic query 121 * @param start the lower bound of the range of model instances 122 * @param end the upper bound of the range of model instances (not inclusive) 123 * @return the range of matching rows 124 */ 125 public <T> java.util.List<T> dynamicQuery( 126 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 127 int end); 128 129 /** 130 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 131 * 132 * <p> 133 * 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. 134 * </p> 135 * 136 * @param dynamicQuery the dynamic query 137 * @param start the lower bound of the range of model instances 138 * @param end the upper bound of the range of model instances (not inclusive) 139 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 140 * @return the ordered range of matching rows 141 */ 142 public <T> java.util.List<T> dynamicQuery( 143 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 144 int end, 145 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 146 147 /** 148 * Returns the number of rows matching the dynamic query. 149 * 150 * @param dynamicQuery the dynamic query 151 * @return the number of rows matching the dynamic query 152 */ 153 public long dynamicQueryCount( 154 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 155 156 /** 157 * Returns the number of rows matching the dynamic query. 158 * 159 * @param dynamicQuery the dynamic query 160 * @param projection the projection to apply to the query 161 * @return the number of rows matching the dynamic query 162 */ 163 public long dynamicQueryCount( 164 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 165 com.liferay.portal.kernel.dao.orm.Projection projection); 166 167 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 168 public com.liferay.portlet.journal.model.JournalArticleResource fetchArticleResource( 169 long groupId, java.lang.String articleId); 170 171 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 172 public com.liferay.portlet.journal.model.JournalArticleResource fetchArticleResource( 173 java.lang.String uuid, long groupId); 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portlet.journal.model.JournalArticleResource fetchJournalArticleResource( 177 long resourcePrimKey); 178 179 /** 180 * Returns the journal article resource matching the UUID and group. 181 * 182 * @param uuid the journal article resource's UUID 183 * @param groupId the primary key of the group 184 * @return the matching journal article resource, or <code>null</code> if a matching journal article resource could not be found 185 */ 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public com.liferay.portlet.journal.model.JournalArticleResource fetchJournalArticleResourceByUuidAndGroupId( 188 java.lang.String uuid, long groupId); 189 190 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 191 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 192 193 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 194 public com.liferay.portlet.journal.model.JournalArticleResource getArticleResource( 195 long articleResourcePrimKey) throws PortalException; 196 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public long getArticleResourcePrimKey(long groupId, 199 java.lang.String articleId); 200 201 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 202 public long getArticleResourcePrimKey(java.lang.String uuid, long groupId, 203 java.lang.String articleId); 204 205 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 206 public java.util.List<com.liferay.portlet.journal.model.JournalArticleResource> getArticleResources( 207 long groupId); 208 209 /** 210 * Returns the Spring bean ID for this bean. 211 * 212 * @return the Spring bean ID for this bean 213 */ 214 public java.lang.String getBeanIdentifier(); 215 216 /** 217 * Returns the journal article resource with the primary key. 218 * 219 * @param resourcePrimKey the primary key of the journal article resource 220 * @return the journal article resource 221 * @throws PortalException if a journal article resource with the primary key could not be found 222 */ 223 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 224 public com.liferay.portlet.journal.model.JournalArticleResource getJournalArticleResource( 225 long resourcePrimKey) throws PortalException; 226 227 /** 228 * Returns the journal article resource matching the UUID and group. 229 * 230 * @param uuid the journal article resource's UUID 231 * @param groupId the primary key of the group 232 * @return the matching journal article resource 233 * @throws PortalException if a matching journal article resource could not be found 234 */ 235 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 236 public com.liferay.portlet.journal.model.JournalArticleResource getJournalArticleResourceByUuidAndGroupId( 237 java.lang.String uuid, long groupId) throws PortalException; 238 239 /** 240 * Returns a range of all the journal article resources. 241 * 242 * <p> 243 * 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. 244 * </p> 245 * 246 * @param start the lower bound of the range of journal article resources 247 * @param end the upper bound of the range of journal article resources (not inclusive) 248 * @return the range of journal article resources 249 */ 250 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 251 public java.util.List<com.liferay.portlet.journal.model.JournalArticleResource> getJournalArticleResources( 252 int start, int end); 253 254 /** 255 * Returns the number of journal article resources. 256 * 257 * @return the number of journal article resources 258 */ 259 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 260 public int getJournalArticleResourcesCount(); 261 262 @Override 263 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 264 public com.liferay.portal.model.PersistedModel getPersistedModel( 265 java.io.Serializable primaryKeyObj) throws PortalException; 266 267 /** 268 * Sets the Spring bean ID for this bean. 269 * 270 * @param beanIdentifier the Spring bean ID for this bean 271 */ 272 public void setBeanIdentifier(java.lang.String beanIdentifier); 273 274 /** 275 * Updates the journal article resource in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 276 * 277 * @param journalArticleResource the journal article resource 278 * @return the journal article resource that was updated 279 */ 280 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 281 public com.liferay.portlet.journal.model.JournalArticleResource updateJournalArticleResource( 282 com.liferay.portlet.journal.model.JournalArticleResource journalArticleResource); 283 }