001    /**
002     * Copyright (c) 2000-2010 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.annotation.Isolation;
018    import com.liferay.portal.kernel.annotation.Propagation;
019    import com.liferay.portal.kernel.annotation.Transactional;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.exception.SystemException;
022    
023    /**
024     * The interface for the journal template local service.
025     *
026     * <p>
027     * Never modify or reference this interface directly. Always use {@link JournalTemplateLocalServiceUtil} to access the journal template local service. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalTemplateLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
028     * </p>
029     *
030     * <p>
031     * 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.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see JournalTemplateLocalServiceUtil
036     * @see com.liferay.portlet.journal.service.base.JournalTemplateLocalServiceBaseImpl
037     * @see com.liferay.portlet.journal.service.impl.JournalTemplateLocalServiceImpl
038     * @generated
039     */
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface JournalTemplateLocalService {
043            /**
044            * Adds the journal template to the database. Also notifies the appropriate model listeners.
045            *
046            * @param journalTemplate the journal template to add
047            * @return the journal template that was added
048            * @throws SystemException if a system exception occurred
049            */
050            public com.liferay.portlet.journal.model.JournalTemplate addJournalTemplate(
051                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate)
052                    throws com.liferay.portal.kernel.exception.SystemException;
053    
054            /**
055            * Creates a new journal template with the primary key. Does not add the journal template to the database.
056            *
057            * @param id the primary key for the new journal template
058            * @return the new journal template
059            */
060            public com.liferay.portlet.journal.model.JournalTemplate createJournalTemplate(
061                    long id);
062    
063            /**
064            * Deletes the journal template with the primary key from the database. Also notifies the appropriate model listeners.
065            *
066            * @param id the primary key of the journal template to delete
067            * @throws PortalException if a journal template with the primary key could not be found
068            * @throws SystemException if a system exception occurred
069            */
070            public void deleteJournalTemplate(long id)
071                    throws com.liferay.portal.kernel.exception.PortalException,
072                            com.liferay.portal.kernel.exception.SystemException;
073    
074            /**
075            * Deletes the journal template from the database. Also notifies the appropriate model listeners.
076            *
077            * @param journalTemplate the journal template to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public void deleteJournalTemplate(
081                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate)
082                    throws com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Performs a dynamic query on the database and returns the matching rows.
086            *
087            * @param dynamicQuery the dynamic query to search with
088            * @return the matching rows
089            * @throws SystemException if a system exception occurred
090            */
091            @SuppressWarnings("rawtypes")
092            public java.util.List dynamicQuery(
093                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            /**
097            * Performs a dynamic query on the database and returns a range of the matching rows.
098            *
099            * <p>
100            * 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.
101            * </p>
102            *
103            * @param dynamicQuery the dynamic query to search with
104            * @param start the lower bound of the range of model instances to return
105            * @param end the upper bound of the range of model instances to return (not inclusive)
106            * @return the range of matching rows
107            * @throws SystemException if a system exception occurred
108            */
109            @SuppressWarnings("rawtypes")
110            public java.util.List dynamicQuery(
111                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
112                    int end) throws com.liferay.portal.kernel.exception.SystemException;
113    
114            /**
115            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
116            *
117            * <p>
118            * 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query to search with
122            * @param start the lower bound of the range of model instances to return
123            * @param end the upper bound of the range of model instances to return (not inclusive)
124            * @param orderByComparator the comparator to order the results by
125            * @return the ordered range of matching rows
126            * @throws SystemException if a system exception occurred
127            */
128            @SuppressWarnings("rawtypes")
129            public java.util.List dynamicQuery(
130                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
131                    int end,
132                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
133                    throws com.liferay.portal.kernel.exception.SystemException;
134    
135            /**
136            * Counts the number of rows that match the dynamic query.
137            *
138            * @param dynamicQuery the dynamic query to search with
139            * @return the number of rows that match the dynamic query
140            * @throws SystemException if a system exception occurred
141            */
142            public long dynamicQueryCount(
143                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
144                    throws com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Gets the journal template with the primary key.
148            *
149            * @param id the primary key of the journal template to get
150            * @return the journal template
151            * @throws PortalException if a journal template with the primary key could not be found
152            * @throws SystemException if a system exception occurred
153            */
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public com.liferay.portlet.journal.model.JournalTemplate getJournalTemplate(
156                    long id)
157                    throws com.liferay.portal.kernel.exception.PortalException,
158                            com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Gets the journal template with the UUID and group id.
162            *
163            * @param uuid the UUID of journal template to get
164            * @param groupId the group id of the journal template to get
165            * @return the journal template
166            * @throws PortalException if a journal template with the UUID and group id 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.JournalTemplate getJournalTemplateByUuidAndGroupId(
171                    java.lang.String uuid, long groupId)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            /**
176            * Gets a range of all the journal templates.
177            *
178            * <p>
179            * 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.
180            * </p>
181            *
182            * @param start the lower bound of the range of journal templates to return
183            * @param end the upper bound of the range of journal templates to return (not inclusive)
184            * @return the range of journal templates
185            * @throws SystemException if a system exception occurred
186            */
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getJournalTemplates(
189                    int start, int end)
190                    throws com.liferay.portal.kernel.exception.SystemException;
191    
192            /**
193            * Gets the number of journal templates.
194            *
195            * @return the number of journal templates
196            * @throws SystemException if a system exception occurred
197            */
198            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199            public int getJournalTemplatesCount()
200                    throws com.liferay.portal.kernel.exception.SystemException;
201    
202            /**
203            * Updates the journal template in the database. Also notifies the appropriate model listeners.
204            *
205            * @param journalTemplate the journal template to update
206            * @return the journal template that was updated
207            * @throws SystemException if a system exception occurred
208            */
209            public com.liferay.portlet.journal.model.JournalTemplate updateJournalTemplate(
210                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Updates the journal template in the database. Also notifies the appropriate model listeners.
215            *
216            * @param journalTemplate the journal template to update
217            * @param merge whether to merge the journal template 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.
218            * @return the journal template that was updated
219            * @throws SystemException if a system exception occurred
220            */
221            public com.liferay.portlet.journal.model.JournalTemplate updateJournalTemplate(
222                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate,
223                    boolean merge)
224                    throws com.liferay.portal.kernel.exception.SystemException;
225    
226            public com.liferay.portlet.journal.model.JournalTemplate addTemplate(
227                    long userId, long groupId, java.lang.String templateId,
228                    boolean autoTemplateId, java.lang.String structureId,
229                    java.lang.String name, java.lang.String description,
230                    java.lang.String xsl, boolean formatXsl, java.lang.String langType,
231                    boolean cacheable, boolean smallImage, java.lang.String smallImageURL,
232                    java.io.File smallFile,
233                    com.liferay.portal.service.ServiceContext serviceContext)
234                    throws com.liferay.portal.kernel.exception.PortalException,
235                            com.liferay.portal.kernel.exception.SystemException;
236    
237            public void addTemplateResources(long groupId, java.lang.String templateId,
238                    boolean addCommunityPermissions, boolean addGuestPermissions)
239                    throws com.liferay.portal.kernel.exception.PortalException,
240                            com.liferay.portal.kernel.exception.SystemException;
241    
242            public void addTemplateResources(
243                    com.liferay.portlet.journal.model.JournalTemplate template,
244                    boolean addCommunityPermissions, boolean addGuestPermissions)
245                    throws com.liferay.portal.kernel.exception.PortalException,
246                            com.liferay.portal.kernel.exception.SystemException;
247    
248            public void addTemplateResources(long groupId, java.lang.String templateId,
249                    java.lang.String[] communityPermissions,
250                    java.lang.String[] guestPermissions)
251                    throws com.liferay.portal.kernel.exception.PortalException,
252                            com.liferay.portal.kernel.exception.SystemException;
253    
254            public void addTemplateResources(
255                    com.liferay.portlet.journal.model.JournalTemplate template,
256                    java.lang.String[] communityPermissions,
257                    java.lang.String[] guestPermissions)
258                    throws com.liferay.portal.kernel.exception.PortalException,
259                            com.liferay.portal.kernel.exception.SystemException;
260    
261            public void checkNewLine(long groupId, java.lang.String templateId)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException;
264    
265            public com.liferay.portlet.journal.model.JournalTemplate copyTemplate(
266                    long userId, long groupId, java.lang.String oldTemplateId,
267                    java.lang.String newTemplateId, boolean autoTemplateId)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException;
270    
271            public void deleteTemplate(long groupId, java.lang.String templateId)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException;
274    
275            public void deleteTemplate(
276                    com.liferay.portlet.journal.model.JournalTemplate template)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException;
279    
280            public void deleteTemplates(long groupId)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException;
283    
284            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
285            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getStructureTemplates(
286                    long groupId, java.lang.String structureId)
287                    throws com.liferay.portal.kernel.exception.SystemException;
288    
289            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
290            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getStructureTemplates(
291                    long groupId, java.lang.String structureId, int start, int end)
292                    throws com.liferay.portal.kernel.exception.SystemException;
293    
294            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
295            public int getStructureTemplatesCount(long groupId,
296                    java.lang.String structureId)
297                    throws com.liferay.portal.kernel.exception.SystemException;
298    
299            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
300            public com.liferay.portlet.journal.model.JournalTemplate getTemplate(
301                    long id)
302                    throws com.liferay.portal.kernel.exception.PortalException,
303                            com.liferay.portal.kernel.exception.SystemException;
304    
305            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
306            public com.liferay.portlet.journal.model.JournalTemplate getTemplate(
307                    long groupId, java.lang.String templateId)
308                    throws com.liferay.portal.kernel.exception.PortalException,
309                            com.liferay.portal.kernel.exception.SystemException;
310    
311            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
312            public com.liferay.portlet.journal.model.JournalTemplate getTemplateBySmallImageId(
313                    long smallImageId)
314                    throws com.liferay.portal.kernel.exception.PortalException,
315                            com.liferay.portal.kernel.exception.SystemException;
316    
317            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
318            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates()
319                    throws com.liferay.portal.kernel.exception.SystemException;
320    
321            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
322            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates(
323                    long groupId)
324                    throws com.liferay.portal.kernel.exception.SystemException;
325    
326            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
327            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates(
328                    long groupId, int start, int end)
329                    throws com.liferay.portal.kernel.exception.SystemException;
330    
331            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
332            public int getTemplatesCount(long groupId)
333                    throws com.liferay.portal.kernel.exception.SystemException;
334    
335            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
336            public boolean hasTemplate(long groupId, java.lang.String templateId)
337                    throws com.liferay.portal.kernel.exception.SystemException;
338    
339            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
340            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
341                    long companyId, long groupId, java.lang.String keywords,
342                    java.lang.String structureId, java.lang.String structureIdComparator,
343                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
348                    long companyId, long groupId, java.lang.String templateId,
349                    java.lang.String structureId, java.lang.String structureIdComparator,
350                    java.lang.String name, java.lang.String description,
351                    boolean andOperator, int start, int end,
352                    com.liferay.portal.kernel.util.OrderByComparator obc)
353                    throws com.liferay.portal.kernel.exception.SystemException;
354    
355            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
356            public int searchCount(long companyId, long groupId,
357                    java.lang.String keywords, java.lang.String structureId,
358                    java.lang.String structureIdComparator)
359                    throws com.liferay.portal.kernel.exception.SystemException;
360    
361            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
362            public int searchCount(long companyId, long groupId,
363                    java.lang.String templateId, java.lang.String structureId,
364                    java.lang.String structureIdComparator, java.lang.String name,
365                    java.lang.String description, boolean andOperator)
366                    throws com.liferay.portal.kernel.exception.SystemException;
367    
368            public com.liferay.portlet.journal.model.JournalTemplate updateTemplate(
369                    long groupId, java.lang.String templateId,
370                    java.lang.String structureId, java.lang.String name,
371                    java.lang.String description, java.lang.String xsl, boolean formatXsl,
372                    java.lang.String langType, boolean cacheable, boolean smallImage,
373                    java.lang.String smallImageURL, java.io.File smallFile,
374                    com.liferay.portal.service.ServiceContext serviceContext)
375                    throws com.liferay.portal.kernel.exception.PortalException,
376                            com.liferay.portal.kernel.exception.SystemException;
377    }