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 template 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 JournalTemplateLocalServiceUtil
034     * @see com.liferay.portlet.journal.service.base.JournalTemplateLocalServiceBaseImpl
035     * @see com.liferay.portlet.journal.service.impl.JournalTemplateLocalServiceImpl
036     * @generated
037     */
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface JournalTemplateLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * 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.
046             */
047    
048            /**
049            * Adds the journal template to the database. Also notifies the appropriate model listeners.
050            *
051            * @param journalTemplate the journal template
052            * @return the journal template that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portlet.journal.model.JournalTemplate addJournalTemplate(
056                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new journal template with the primary key. Does not add the journal template to the database.
061            *
062            * @param id the primary key for the new journal template
063            * @return the new journal template
064            */
065            public com.liferay.portlet.journal.model.JournalTemplate createJournalTemplate(
066                    long id);
067    
068            /**
069            * Deletes the journal template with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param id the primary key of the journal template
072            * @return the journal template that was removed
073            * @throws PortalException if a journal template with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public com.liferay.portlet.journal.model.JournalTemplate deleteJournalTemplate(
077                    long id)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            /**
082            * Deletes the journal template from the database. Also notifies the appropriate model listeners.
083            *
084            * @param journalTemplate the journal template
085            * @return the journal template that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public com.liferay.portlet.journal.model.JournalTemplate deleteJournalTemplate(
089                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate)
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.JournalTemplate fetchJournalTemplate(
158                    long id) throws com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Returns the journal template with the primary key.
162            *
163            * @param id the primary key of the journal template
164            * @return the journal template
165            * @throws PortalException if a journal template with the primary key could not be found
166            * @throws SystemException if a system exception occurred
167            */
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portlet.journal.model.JournalTemplate getJournalTemplate(
170                    long id)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException;
173    
174            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
175            public com.liferay.portal.model.PersistedModel getPersistedModel(
176                    java.io.Serializable primaryKeyObj)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException;
179    
180            /**
181            * Returns the journal template with the UUID in the group.
182            *
183            * @param uuid the UUID of journal template
184            * @param groupId the group id of the journal template
185            * @return the journal template
186            * @throws PortalException if a journal template with the UUID in the group could not be found
187            * @throws SystemException if a system exception occurred
188            */
189            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
190            public com.liferay.portlet.journal.model.JournalTemplate getJournalTemplateByUuidAndGroupId(
191                    java.lang.String uuid, long groupId)
192                    throws com.liferay.portal.kernel.exception.PortalException,
193                            com.liferay.portal.kernel.exception.SystemException;
194    
195            /**
196            * Returns a range of all the journal templates.
197            *
198            * <p>
199            * 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.
200            * </p>
201            *
202            * @param start the lower bound of the range of journal templates
203            * @param end the upper bound of the range of journal templates (not inclusive)
204            * @return the range of journal templates
205            * @throws SystemException if a system exception occurred
206            */
207            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getJournalTemplates(
209                    int start, int end)
210                    throws com.liferay.portal.kernel.exception.SystemException;
211    
212            /**
213            * Returns the number of journal templates.
214            *
215            * @return the number of journal templates
216            * @throws SystemException if a system exception occurred
217            */
218            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219            public int getJournalTemplatesCount()
220                    throws com.liferay.portal.kernel.exception.SystemException;
221    
222            /**
223            * Updates the journal template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
224            *
225            * @param journalTemplate the journal template
226            * @return the journal template that was updated
227            * @throws SystemException if a system exception occurred
228            */
229            public com.liferay.portlet.journal.model.JournalTemplate updateJournalTemplate(
230                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate)
231                    throws com.liferay.portal.kernel.exception.SystemException;
232    
233            /**
234            * Updates the journal template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
235            *
236            * @param journalTemplate the journal template
237            * @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.
238            * @return the journal template that was updated
239            * @throws SystemException if a system exception occurred
240            */
241            public com.liferay.portlet.journal.model.JournalTemplate updateJournalTemplate(
242                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate,
243                    boolean merge)
244                    throws com.liferay.portal.kernel.exception.SystemException;
245    
246            /**
247            * Returns the Spring bean ID for this bean.
248            *
249            * @return the Spring bean ID for this bean
250            */
251            public java.lang.String getBeanIdentifier();
252    
253            /**
254            * Sets the Spring bean ID for this bean.
255            *
256            * @param beanIdentifier the Spring bean ID for this bean
257            */
258            public void setBeanIdentifier(java.lang.String beanIdentifier);
259    
260            public com.liferay.portlet.journal.model.JournalTemplate addTemplate(
261                    long userId, long groupId, java.lang.String templateId,
262                    boolean autoTemplateId, java.lang.String structureId,
263                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
264                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
265                    java.lang.String xsl, boolean formatXsl, java.lang.String langType,
266                    boolean cacheable, boolean smallImage, java.lang.String smallImageURL,
267                    java.io.File smallImageFile,
268                    com.liferay.portal.service.ServiceContext serviceContext)
269                    throws com.liferay.portal.kernel.exception.PortalException,
270                            com.liferay.portal.kernel.exception.SystemException;
271    
272            public void addTemplateResources(
273                    com.liferay.portlet.journal.model.JournalTemplate template,
274                    boolean addGroupPermissions, boolean addGuestPermissions)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException;
277    
278            public void addTemplateResources(
279                    com.liferay.portlet.journal.model.JournalTemplate template,
280                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException;
283    
284            public void addTemplateResources(long groupId, java.lang.String templateId,
285                    boolean addGroupPermissions, boolean addGuestPermissions)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException;
288    
289            public void addTemplateResources(long groupId, java.lang.String templateId,
290                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException;
293    
294            public void checkNewLine(long groupId, java.lang.String templateId)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException;
297    
298            public com.liferay.portlet.journal.model.JournalTemplate copyTemplate(
299                    long userId, long groupId, java.lang.String oldTemplateId,
300                    java.lang.String newTemplateId, boolean autoTemplateId)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException;
303    
304            public void deleteTemplate(
305                    com.liferay.portlet.journal.model.JournalTemplate template)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException;
308    
309            public void deleteTemplate(long groupId, java.lang.String templateId)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException;
312    
313            public void deleteTemplates(long groupId)
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> getStructureTemplates(
319                    long groupId, java.lang.String structureId)
320                    throws com.liferay.portal.kernel.exception.SystemException;
321    
322            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
323            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getStructureTemplates(
324                    long groupId, java.lang.String structureId, int start, int end)
325                    throws com.liferay.portal.kernel.exception.SystemException;
326    
327            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
328            public int getStructureTemplatesCount(long groupId,
329                    java.lang.String structureId)
330                    throws com.liferay.portal.kernel.exception.SystemException;
331    
332            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
333            public com.liferay.portlet.journal.model.JournalTemplate getTemplate(
334                    long id)
335                    throws com.liferay.portal.kernel.exception.PortalException,
336                            com.liferay.portal.kernel.exception.SystemException;
337    
338            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
339            public com.liferay.portlet.journal.model.JournalTemplate getTemplate(
340                    long groupId, java.lang.String templateId)
341                    throws com.liferay.portal.kernel.exception.PortalException,
342                            com.liferay.portal.kernel.exception.SystemException;
343    
344            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
345            public com.liferay.portlet.journal.model.JournalTemplate getTemplate(
346                    long groupId, java.lang.String templateId,
347                    boolean includeGlobalTemplates)
348                    throws com.liferay.portal.kernel.exception.PortalException,
349                            com.liferay.portal.kernel.exception.SystemException;
350    
351            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
352            public com.liferay.portlet.journal.model.JournalTemplate getTemplateBySmallImageId(
353                    long smallImageId)
354                    throws com.liferay.portal.kernel.exception.PortalException,
355                            com.liferay.portal.kernel.exception.SystemException;
356    
357            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
358            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates()
359                    throws com.liferay.portal.kernel.exception.SystemException;
360    
361            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
362            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates(
363                    long groupId)
364                    throws com.liferay.portal.kernel.exception.SystemException;
365    
366            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
367            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates(
368                    long groupId, int start, int end)
369                    throws com.liferay.portal.kernel.exception.SystemException;
370    
371            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
372            public int getTemplatesCount(long groupId)
373                    throws com.liferay.portal.kernel.exception.SystemException;
374    
375            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
376            public boolean hasTemplate(long groupId, java.lang.String templateId)
377                    throws com.liferay.portal.kernel.exception.SystemException;
378    
379            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
380            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
381                    long companyId, long[] groupIds, java.lang.String keywords,
382                    java.lang.String structureId, java.lang.String structureIdComparator,
383                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
384                    throws com.liferay.portal.kernel.exception.SystemException;
385    
386            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
387            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
388                    long companyId, long[] groupIds, java.lang.String templateId,
389                    java.lang.String structureId, java.lang.String structureIdComparator,
390                    java.lang.String name, java.lang.String description,
391                    boolean andOperator, int start, int end,
392                    com.liferay.portal.kernel.util.OrderByComparator obc)
393                    throws com.liferay.portal.kernel.exception.SystemException;
394    
395            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
396            public int searchCount(long companyId, long[] groupIds,
397                    java.lang.String keywords, java.lang.String structureId,
398                    java.lang.String structureIdComparator)
399                    throws com.liferay.portal.kernel.exception.SystemException;
400    
401            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
402            public int searchCount(long companyId, long[] groupIds,
403                    java.lang.String templateId, java.lang.String structureId,
404                    java.lang.String structureIdComparator, java.lang.String name,
405                    java.lang.String description, boolean andOperator)
406                    throws com.liferay.portal.kernel.exception.SystemException;
407    
408            public com.liferay.portlet.journal.model.JournalTemplate updateTemplate(
409                    long groupId, java.lang.String templateId,
410                    java.lang.String structureId,
411                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
412                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
413                    java.lang.String xsl, boolean formatXsl, java.lang.String langType,
414                    boolean cacheable, boolean smallImage, java.lang.String smallImageURL,
415                    java.io.File smallImageFile,
416                    com.liferay.portal.service.ServiceContext serviceContext)
417                    throws com.liferay.portal.kernel.exception.PortalException,
418                            com.liferay.portal.kernel.exception.SystemException;
419    }