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