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