001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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            /**
150            * Returns the journal template with the primary key.
151            *
152            * @param id the primary key of the journal template
153            * @return the journal template
154            * @throws PortalException if a journal template with the primary key could not be found
155            * @throws SystemException if a system exception occurred
156            */
157            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
158            public com.liferay.portlet.journal.model.JournalTemplate getJournalTemplate(
159                    long id)
160                    throws com.liferay.portal.kernel.exception.PortalException,
161                            com.liferay.portal.kernel.exception.SystemException;
162    
163            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164            public com.liferay.portal.model.PersistedModel getPersistedModel(
165                    java.io.Serializable primaryKeyObj)
166                    throws com.liferay.portal.kernel.exception.PortalException,
167                            com.liferay.portal.kernel.exception.SystemException;
168    
169            /**
170            * Returns the journal template with the UUID in the group.
171            *
172            * @param uuid the UUID of journal template
173            * @param groupId the group id of the journal template
174            * @return the journal template
175            * @throws PortalException if a journal template with the UUID in the group could not be found
176            * @throws SystemException if a system exception occurred
177            */
178            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179            public com.liferay.portlet.journal.model.JournalTemplate getJournalTemplateByUuidAndGroupId(
180                    java.lang.String uuid, long groupId)
181                    throws com.liferay.portal.kernel.exception.PortalException,
182                            com.liferay.portal.kernel.exception.SystemException;
183    
184            /**
185            * Returns a range of all the journal templates.
186            *
187            * <p>
188            * 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.
189            * </p>
190            *
191            * @param start the lower bound of the range of journal templates
192            * @param end the upper bound of the range of journal templates (not inclusive)
193            * @return the range of journal templates
194            * @throws SystemException if a system exception occurred
195            */
196            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
197            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getJournalTemplates(
198                    int start, int end)
199                    throws com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Returns the number of journal templates.
203            *
204            * @return the number of journal templates
205            * @throws SystemException if a system exception occurred
206            */
207            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208            public int getJournalTemplatesCount()
209                    throws com.liferay.portal.kernel.exception.SystemException;
210    
211            /**
212            * Updates the journal template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
213            *
214            * @param journalTemplate the journal template
215            * @return the journal template that was updated
216            * @throws SystemException if a system exception occurred
217            */
218            public com.liferay.portlet.journal.model.JournalTemplate updateJournalTemplate(
219                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate)
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            * @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.
227            * @return the journal template that was updated
228            * @throws SystemException if a system exception occurred
229            */
230            public com.liferay.portlet.journal.model.JournalTemplate updateJournalTemplate(
231                    com.liferay.portlet.journal.model.JournalTemplate journalTemplate,
232                    boolean merge)
233                    throws com.liferay.portal.kernel.exception.SystemException;
234    
235            /**
236            * Returns the Spring bean ID for this bean.
237            *
238            * @return the Spring bean ID for this bean
239            */
240            public java.lang.String getBeanIdentifier();
241    
242            /**
243            * Sets the Spring bean ID for this bean.
244            *
245            * @param beanIdentifier the Spring bean ID for this bean
246            */
247            public void setBeanIdentifier(java.lang.String beanIdentifier);
248    
249            public com.liferay.portlet.journal.model.JournalTemplate addTemplate(
250                    long userId, long groupId, java.lang.String templateId,
251                    boolean autoTemplateId, java.lang.String structureId,
252                    java.lang.String name, java.lang.String description,
253                    java.lang.String xsl, boolean formatXsl, java.lang.String langType,
254                    boolean cacheable, boolean smallImage, java.lang.String smallImageURL,
255                    java.io.File smallFile,
256                    com.liferay.portal.service.ServiceContext serviceContext)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    
260            public void addTemplateResources(
261                    com.liferay.portlet.journal.model.JournalTemplate template,
262                    boolean addCommunityPermissions, boolean addGuestPermissions)
263                    throws com.liferay.portal.kernel.exception.PortalException,
264                            com.liferay.portal.kernel.exception.SystemException;
265    
266            public void addTemplateResources(
267                    com.liferay.portlet.journal.model.JournalTemplate template,
268                    java.lang.String[] communityPermissions,
269                    java.lang.String[] guestPermissions)
270                    throws com.liferay.portal.kernel.exception.PortalException,
271                            com.liferay.portal.kernel.exception.SystemException;
272    
273            public void addTemplateResources(long groupId, java.lang.String templateId,
274                    boolean addCommunityPermissions, boolean addGuestPermissions)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException;
277    
278            public void addTemplateResources(long groupId, java.lang.String templateId,
279                    java.lang.String[] communityPermissions,
280                    java.lang.String[] guestPermissions)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException;
283    
284            public void checkNewLine(long groupId, java.lang.String templateId)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            public com.liferay.portlet.journal.model.JournalTemplate copyTemplate(
289                    long userId, long groupId, java.lang.String oldTemplateId,
290                    java.lang.String newTemplateId, boolean autoTemplateId)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException;
293    
294            public void deleteTemplate(
295                    com.liferay.portlet.journal.model.JournalTemplate template)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException;
298    
299            public void deleteTemplate(long groupId, java.lang.String templateId)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException;
302    
303            public void deleteTemplates(long groupId)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException;
306    
307            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
308            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getStructureTemplates(
309                    long groupId, java.lang.String structureId)
310                    throws com.liferay.portal.kernel.exception.SystemException;
311    
312            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
313            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getStructureTemplates(
314                    long groupId, java.lang.String structureId, int start, int end)
315                    throws com.liferay.portal.kernel.exception.SystemException;
316    
317            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
318            public int getStructureTemplatesCount(long groupId,
319                    java.lang.String structureId)
320                    throws com.liferay.portal.kernel.exception.SystemException;
321    
322            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
323            public com.liferay.portlet.journal.model.JournalTemplate getTemplate(
324                    long id)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException;
327    
328            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
329            public com.liferay.portlet.journal.model.JournalTemplate getTemplate(
330                    long groupId, java.lang.String templateId)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException;
333    
334            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
335            public com.liferay.portlet.journal.model.JournalTemplate getTemplateBySmallImageId(
336                    long smallImageId)
337                    throws com.liferay.portal.kernel.exception.PortalException,
338                            com.liferay.portal.kernel.exception.SystemException;
339    
340            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
341            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates()
342                    throws com.liferay.portal.kernel.exception.SystemException;
343    
344            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
345            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates(
346                    long groupId)
347                    throws com.liferay.portal.kernel.exception.SystemException;
348    
349            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
350            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> getTemplates(
351                    long groupId, int start, int end)
352                    throws com.liferay.portal.kernel.exception.SystemException;
353    
354            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
355            public int getTemplatesCount(long groupId)
356                    throws com.liferay.portal.kernel.exception.SystemException;
357    
358            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
359            public boolean hasTemplate(long groupId, java.lang.String templateId)
360                    throws com.liferay.portal.kernel.exception.SystemException;
361    
362            /**
363            * @deprecated {@link #search(long, long[], String, String, String, int,
364            int, OrderByComparator)}
365            */
366            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
367            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
368                    long companyId, long groupId, java.lang.String keywords,
369                    java.lang.String structureId, java.lang.String structureIdComparator,
370                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
371                    throws com.liferay.portal.kernel.exception.SystemException;
372    
373            /**
374            * @deprecated {@link #search(long, long[], String, String, String, String,
375            String, boolean, int, int, OrderByComparator)}
376            */
377            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
378            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
379                    long companyId, long groupId, java.lang.String templateId,
380                    java.lang.String structureId, java.lang.String structureIdComparator,
381                    java.lang.String name, java.lang.String description,
382                    boolean andOperator, int start, int end,
383                    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 keywords,
389                    java.lang.String structureId, java.lang.String structureIdComparator,
390                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
391                    throws com.liferay.portal.kernel.exception.SystemException;
392    
393            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
394            public java.util.List<com.liferay.portlet.journal.model.JournalTemplate> search(
395                    long companyId, long[] groupIds, java.lang.String templateId,
396                    java.lang.String structureId, java.lang.String structureIdComparator,
397                    java.lang.String name, java.lang.String description,
398                    boolean andOperator, int start, int end,
399                    com.liferay.portal.kernel.util.OrderByComparator obc)
400                    throws com.liferay.portal.kernel.exception.SystemException;
401    
402            /**
403            * @deprecated {@link #searchCount(long, long[], String, String, String)}
404            */
405            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
406            public int searchCount(long companyId, long groupId,
407                    java.lang.String keywords, java.lang.String structureId,
408                    java.lang.String structureIdComparator)
409                    throws com.liferay.portal.kernel.exception.SystemException;
410    
411            /**
412            * @deprecated {@link #searchCount(long, long[], String, String, String,
413            String, String, boolean)}
414            */
415            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
416            public int searchCount(long companyId, long groupId,
417                    java.lang.String templateId, java.lang.String structureId,
418                    java.lang.String structureIdComparator, java.lang.String name,
419                    java.lang.String description, boolean andOperator)
420                    throws com.liferay.portal.kernel.exception.SystemException;
421    
422            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
423            public int searchCount(long companyId, long[] groupIds,
424                    java.lang.String keywords, java.lang.String structureId,
425                    java.lang.String structureIdComparator)
426                    throws com.liferay.portal.kernel.exception.SystemException;
427    
428            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
429            public int searchCount(long companyId, long[] groupIds,
430                    java.lang.String templateId, java.lang.String structureId,
431                    java.lang.String structureIdComparator, java.lang.String name,
432                    java.lang.String description, boolean andOperator)
433                    throws com.liferay.portal.kernel.exception.SystemException;
434    
435            public com.liferay.portlet.journal.model.JournalTemplate updateTemplate(
436                    long groupId, java.lang.String templateId,
437                    java.lang.String structureId, java.lang.String name,
438                    java.lang.String description, java.lang.String xsl, boolean formatXsl,
439                    java.lang.String langType, boolean cacheable, boolean smallImage,
440                    java.lang.String smallImageURL, java.io.File smallFile,
441                    com.liferay.portal.service.ServiceContext serviceContext)
442                    throws com.liferay.portal.kernel.exception.PortalException,
443                            com.liferay.portal.kernel.exception.SystemException;
444    }