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.dynamicdatamapping.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 d d m 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 DDMTemplateLocalServiceUtil
033     * @see com.liferay.portlet.dynamicdatamapping.service.base.DDMTemplateLocalServiceBaseImpl
034     * @see com.liferay.portlet.dynamicdatamapping.service.impl.DDMTemplateLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface DDMTemplateLocalService extends PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. Always use {@link DDMTemplateLocalServiceUtil} to access the d d m template local service. Add custom service methods to {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMTemplateLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
044             */
045    
046            /**
047            * Adds the d d m template to the database. Also notifies the appropriate model listeners.
048            *
049            * @param ddmTemplate the d d m template
050            * @return the d d m template that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate addDDMTemplate(
054                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate ddmTemplate)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new d d m template with the primary key. Does not add the d d m template to the database.
059            *
060            * @param templateId the primary key for the new d d m template
061            * @return the new d d m template
062            */
063            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate createDDMTemplate(
064                    long templateId);
065    
066            /**
067            * Deletes the d d m template with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param templateId the primary key of the d d m template
070            * @throws PortalException if a d d m template with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public void deleteDDMTemplate(long templateId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Deletes the d d m template from the database. Also notifies the appropriate model listeners.
079            *
080            * @param ddmTemplate the d d m template
081            * @throws SystemException if a system exception occurred
082            */
083            public void deleteDDMTemplate(
084                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate ddmTemplate)
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.dynamicdatamapping.model.DDMTemplate fetchDDMTemplate(
151                    long templateId)
152                    throws com.liferay.portal.kernel.exception.SystemException;
153    
154            /**
155            * Returns the d d m template with the primary key.
156            *
157            * @param templateId the primary key of the d d m template
158            * @return the d d m template
159            * @throws PortalException if a d d m template with the primary key could not be found
160            * @throws SystemException if a system exception occurred
161            */
162            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
163            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate getDDMTemplate(
164                    long templateId)
165                    throws com.liferay.portal.kernel.exception.PortalException,
166                            com.liferay.portal.kernel.exception.SystemException;
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portal.model.PersistedModel getPersistedModel(
170                    java.io.Serializable primaryKeyObj)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException;
173    
174            /**
175            * Returns the d d m template with the UUID in the group.
176            *
177            * @param uuid the UUID of d d m template
178            * @param groupId the group id of the d d m template
179            * @return the d d m template
180            * @throws PortalException if a d d m template with the UUID in the group could not be found
181            * @throws SystemException if a system exception occurred
182            */
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate getDDMTemplateByUuidAndGroupId(
185                    java.lang.String uuid, long groupId)
186                    throws com.liferay.portal.kernel.exception.PortalException,
187                            com.liferay.portal.kernel.exception.SystemException;
188    
189            /**
190            * Returns a range of all the d d m templates.
191            *
192            * <p>
193            * 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.
194            * </p>
195            *
196            * @param start the lower bound of the range of d d m templates
197            * @param end the upper bound of the range of d d m templates (not inclusive)
198            * @return the range of d d m templates
199            * @throws SystemException if a system exception occurred
200            */
201            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
202            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getDDMTemplates(
203                    int start, int end)
204                    throws com.liferay.portal.kernel.exception.SystemException;
205    
206            /**
207            * Returns the number of d d m templates.
208            *
209            * @return the number of d d m templates
210            * @throws SystemException if a system exception occurred
211            */
212            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
213            public int getDDMTemplatesCount()
214                    throws com.liferay.portal.kernel.exception.SystemException;
215    
216            /**
217            * Updates the d d m template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
218            *
219            * @param ddmTemplate the d d m template
220            * @return the d d m template that was updated
221            * @throws SystemException if a system exception occurred
222            */
223            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate updateDDMTemplate(
224                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate ddmTemplate)
225                    throws com.liferay.portal.kernel.exception.SystemException;
226    
227            /**
228            * Updates the d d m template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
229            *
230            * @param ddmTemplate the d d m template
231            * @param merge whether to merge the d d m 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.
232            * @return the d d m template that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate updateDDMTemplate(
236                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate ddmTemplate,
237                    boolean merge)
238                    throws com.liferay.portal.kernel.exception.SystemException;
239    
240            /**
241            * Returns the Spring bean ID for this bean.
242            *
243            * @return the Spring bean ID for this bean
244            */
245            public java.lang.String getBeanIdentifier();
246    
247            /**
248            * Sets the Spring bean ID for this bean.
249            *
250            * @param beanIdentifier the Spring bean ID for this bean
251            */
252            public void setBeanIdentifier(java.lang.String beanIdentifier);
253    
254            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate addTemplate(
255                    long userId, long groupId, long 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 type, java.lang.String mode,
259                    java.lang.String language, java.lang.String script,
260                    com.liferay.portal.service.ServiceContext serviceContext)
261                    throws com.liferay.portal.kernel.exception.PortalException,
262                            com.liferay.portal.kernel.exception.SystemException;
263    
264            public void addTemplateResources(
265                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate template,
266                    boolean addGroupPermissions, boolean addGuestPermissions)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException;
269    
270            public void addTemplateResources(
271                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate template,
272                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException;
275    
276            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> copyTemplates(
277                    long userId, long structureId, long newStructureId,
278                    java.lang.String type,
279                    com.liferay.portal.service.ServiceContext serviceContext)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException;
282    
283            public void deleteTemplate(
284                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate template)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            public void deleteTemplate(long templateId)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException;
291    
292            public void deleteTemplates(long groupId)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException;
295    
296            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
297            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate getTemplate(
298                    long templateId)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException;
301    
302            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
303            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(
304                    long structureId)
305                    throws com.liferay.portal.kernel.exception.SystemException;
306    
307            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
308            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(
309                    long structureId, java.lang.String type)
310                    throws com.liferay.portal.kernel.exception.SystemException;
311    
312            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
313            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(
314                    long structureId, java.lang.String type, java.lang.String mode)
315                    throws com.liferay.portal.kernel.exception.SystemException;
316    
317            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
318            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> search(
319                    long companyId, long groupId, long structureId,
320                    java.lang.String keywords, java.lang.String type,
321                    java.lang.String mode, int start, int end,
322                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
323                    throws com.liferay.portal.kernel.exception.SystemException;
324    
325            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
326            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> search(
327                    long companyId, long groupId, long structureId, java.lang.String name,
328                    java.lang.String description, java.lang.String type,
329                    java.lang.String mode, java.lang.String language, boolean andOperator,
330                    int start, int end,
331                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
332                    throws com.liferay.portal.kernel.exception.SystemException;
333    
334            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
335            public int searchCount(long companyId, long groupId, long structureId,
336                    java.lang.String keywords, java.lang.String type, java.lang.String mode)
337                    throws com.liferay.portal.kernel.exception.SystemException;
338    
339            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
340            public int searchCount(long companyId, long groupId, long structureId,
341                    java.lang.String name, java.lang.String description,
342                    java.lang.String type, java.lang.String mode,
343                    java.lang.String language, boolean andOperator)
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    
346            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate updateTemplate(
347                    long templateId,
348                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
349                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
350                    java.lang.String type, java.lang.String mode,
351                    java.lang.String language, java.lang.String script,
352                    com.liferay.portal.service.ServiceContext serviceContext)
353                    throws com.liferay.portal.kernel.exception.PortalException,
354                            com.liferay.portal.kernel.exception.SystemException;
355    }