001    /**
002     * Copyright (c) 2000-2011 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            /**
151            * Returns the journal article resource with the primary key.
152            *
153            * @param resourcePrimKey the primary key of the journal article resource
154            * @return the journal article resource
155            * @throws PortalException if a journal article resource with the primary key could not be found
156            * @throws SystemException if a system exception occurred
157            */
158            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
159            public com.liferay.portlet.journal.model.JournalArticleResource getJournalArticleResource(
160                    long resourcePrimKey)
161                    throws com.liferay.portal.kernel.exception.PortalException,
162                            com.liferay.portal.kernel.exception.SystemException;
163    
164            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
165            public com.liferay.portal.model.PersistedModel getPersistedModel(
166                    java.io.Serializable primaryKeyObj)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException;
169    
170            /**
171            * Returns the journal article resource with the UUID in the group.
172            *
173            * @param uuid the UUID of journal article resource
174            * @param groupId the group id of the journal article resource
175            * @return the journal article resource
176            * @throws PortalException if a journal article resource with the UUID in the group could not be found
177            * @throws SystemException if a system exception occurred
178            */
179            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
180            public com.liferay.portlet.journal.model.JournalArticleResource getJournalArticleResourceByUuidAndGroupId(
181                    java.lang.String uuid, long groupId)
182                    throws com.liferay.portal.kernel.exception.PortalException,
183                            com.liferay.portal.kernel.exception.SystemException;
184    
185            /**
186            * Returns a range of all the journal article resources.
187            *
188            * <p>
189            * 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.
190            * </p>
191            *
192            * @param start the lower bound of the range of journal article resources
193            * @param end the upper bound of the range of journal article resources (not inclusive)
194            * @return the range of journal article resources
195            * @throws SystemException if a system exception occurred
196            */
197            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
198            public java.util.List<com.liferay.portlet.journal.model.JournalArticleResource> getJournalArticleResources(
199                    int start, int end)
200                    throws com.liferay.portal.kernel.exception.SystemException;
201    
202            /**
203            * Returns the number of journal article resources.
204            *
205            * @return the number of journal article resources
206            * @throws SystemException if a system exception occurred
207            */
208            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209            public int getJournalArticleResourcesCount()
210                    throws com.liferay.portal.kernel.exception.SystemException;
211    
212            /**
213            * Updates the journal article resource in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param journalArticleResource the journal article resource
216            * @return the journal article resource that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public com.liferay.portlet.journal.model.JournalArticleResource updateJournalArticleResource(
220                    com.liferay.portlet.journal.model.JournalArticleResource journalArticleResource)
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            * @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.
228            * @return the journal article resource that was updated
229            * @throws SystemException if a system exception occurred
230            */
231            public com.liferay.portlet.journal.model.JournalArticleResource updateJournalArticleResource(
232                    com.liferay.portlet.journal.model.JournalArticleResource journalArticleResource,
233                    boolean merge)
234                    throws com.liferay.portal.kernel.exception.SystemException;
235    
236            /**
237            * Returns the Spring bean ID for this bean.
238            *
239            * @return the Spring bean ID for this bean
240            */
241            public java.lang.String getBeanIdentifier();
242    
243            /**
244            * Sets the Spring bean ID for this bean.
245            *
246            * @param beanIdentifier the Spring bean ID for this bean
247            */
248            public void setBeanIdentifier(java.lang.String beanIdentifier);
249    
250            public void deleteArticleResource(long groupId, java.lang.String articleId)
251                    throws com.liferay.portal.kernel.exception.PortalException,
252                            com.liferay.portal.kernel.exception.SystemException;
253    
254            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
255            public com.liferay.portlet.journal.model.JournalArticleResource getArticleResource(
256                    long articleResourcePrimKey)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    
260            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
261            public long getArticleResourcePrimKey(long groupId,
262                    java.lang.String articleId)
263                    throws com.liferay.portal.kernel.exception.SystemException;
264    
265            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
266            public long getArticleResourcePrimKey(java.lang.String uuid, 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 java.util.List<com.liferay.portlet.journal.model.JournalArticleResource> getArticleResources(
272                    long groupId)
273                    throws com.liferay.portal.kernel.exception.SystemException;
274    }