001    /**
002     * Copyright (c) 2000-2011 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            /**
150            * Returns the d d m template with the primary key.
151            *
152            * @param templateId the primary key of the d d m template
153            * @return the d d m template
154            * @throws PortalException if a d d m 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.dynamicdatamapping.model.DDMTemplate getDDMTemplate(
159                    long templateId)
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 d d m template with the UUID in the group.
171            *
172            * @param uuid the UUID of d d m template
173            * @param groupId the group id of the d d m template
174            * @return the d d m template
175            * @throws PortalException if a d d m 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.dynamicdatamapping.model.DDMTemplate getDDMTemplateByUuidAndGroupId(
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 d d m 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 d d m templates
192            * @param end the upper bound of the range of d d m templates (not inclusive)
193            * @return the range of d d m 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.dynamicdatamapping.model.DDMTemplate> getDDMTemplates(
198                    int start, int end)
199                    throws com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Returns the number of d d m templates.
203            *
204            * @return the number of d d m templates
205            * @throws SystemException if a system exception occurred
206            */
207            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208            public int getDDMTemplatesCount()
209                    throws com.liferay.portal.kernel.exception.SystemException;
210    
211            /**
212            * Updates the d d m template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
213            *
214            * @param ddmTemplate the d d m template
215            * @return the d d m template that was updated
216            * @throws SystemException if a system exception occurred
217            */
218            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate updateDDMTemplate(
219                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate ddmTemplate)
220                    throws com.liferay.portal.kernel.exception.SystemException;
221    
222            /**
223            * Updates the d d m template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
224            *
225            * @param ddmTemplate the d d m template
226            * @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.
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                    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.dynamicdatamapping.model.DDMTemplate addTemplate(
250                    long userId, long groupId, long structureId,
251                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
252                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
253                    java.lang.String type, java.lang.String mode,
254                    java.lang.String language, java.lang.String script,
255                    com.liferay.portal.service.ServiceContext serviceContext)
256                    throws com.liferay.portal.kernel.exception.PortalException,
257                            com.liferay.portal.kernel.exception.SystemException;
258    
259            public void addTemplateResources(
260                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate template,
261                    boolean addGroupPermissions, boolean addGuestPermissions)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException;
264    
265            public void addTemplateResources(
266                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate template,
267                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException;
270    
271            public void deleteTemplate(
272                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate template)
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException;
275    
276            public void deleteTemplate(long templateId)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException;
279    
280            public void deleteTemplates(long groupId)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException;
283    
284            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
285            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate getTemplate(
286                    long templateId)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException;
289    
290            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
291            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(
292                    long structureId)
293                    throws com.liferay.portal.kernel.exception.SystemException;
294    
295            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
296            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(
297                    long structureId, java.lang.String type, java.lang.String mode)
298                    throws com.liferay.portal.kernel.exception.SystemException;
299    
300            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
301            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> search(
302                    long companyId, long groupId, long structureId,
303                    java.lang.String keywords, java.lang.String type,
304                    java.lang.String mode, int start, int end,
305                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
306                    throws com.liferay.portal.kernel.exception.SystemException;
307    
308            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
309            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> search(
310                    long companyId, long groupId, long structureId, java.lang.String name,
311                    java.lang.String description, java.lang.String type,
312                    java.lang.String mode, java.lang.String language, boolean andOperator,
313                    int start, int end,
314                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
315                    throws com.liferay.portal.kernel.exception.SystemException;
316    
317            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
318            public int searchCount(long companyId, long groupId, long structureId,
319                    java.lang.String keywords, java.lang.String type, java.lang.String mode)
320                    throws com.liferay.portal.kernel.exception.SystemException;
321    
322            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
323            public int searchCount(long companyId, long groupId, long structureId,
324                    java.lang.String name, java.lang.String description,
325                    java.lang.String type, java.lang.String mode,
326                    java.lang.String language, boolean andOperator)
327                    throws com.liferay.portal.kernel.exception.SystemException;
328    
329            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate updateTemplate(
330                    long templateId,
331                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
332                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
333                    java.lang.String type, java.lang.String mode,
334                    java.lang.String language, java.lang.String script,
335                    com.liferay.portal.service.ServiceContext serviceContext)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException;
338    }