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.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.ReferenceRegistry;
019    
020    /**
021     * The utility for the d d m template local service. This utility wraps {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMTemplateLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
022     *
023     * <p>
024     * 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.
025     * </p>
026     *
027     * @author Brian Wing Shun Chan
028     * @see DDMTemplateLocalService
029     * @see com.liferay.portlet.dynamicdatamapping.service.base.DDMTemplateLocalServiceBaseImpl
030     * @see com.liferay.portlet.dynamicdatamapping.service.impl.DDMTemplateLocalServiceImpl
031     * @generated
032     */
033    public class DDMTemplateLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMTemplateLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the d d m template to the database. Also notifies the appropriate model listeners.
042            *
043            * @param ddmTemplate the d d m template
044            * @return the d d m template that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate addDDMTemplate(
048                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate ddmTemplate)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addDDMTemplate(ddmTemplate);
051            }
052    
053            /**
054            * Creates a new d d m template with the primary key. Does not add the d d m template to the database.
055            *
056            * @param templateId the primary key for the new d d m template
057            * @return the new d d m template
058            */
059            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate createDDMTemplate(
060                    long templateId) {
061                    return getService().createDDMTemplate(templateId);
062            }
063    
064            /**
065            * Deletes the d d m template with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param templateId the primary key of the d d m template
068            * @return the d d m template that was removed
069            * @throws PortalException if a d d m template with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate deleteDDMTemplate(
073                    long templateId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteDDMTemplate(templateId);
077            }
078    
079            /**
080            * Deletes the d d m template from the database. Also notifies the appropriate model listeners.
081            *
082            * @param ddmTemplate the d d m template
083            * @return the d d m template that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate deleteDDMTemplate(
087                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate ddmTemplate)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteDDMTemplate(ddmTemplate);
090            }
091    
092            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
093                    return getService().dynamicQuery();
094            }
095    
096            /**
097            * Performs a dynamic query on the database and returns the matching rows.
098            *
099            * @param dynamicQuery the dynamic query
100            * @return the matching rows
101            * @throws SystemException if a system exception occurred
102            */
103            @SuppressWarnings("rawtypes")
104            public static java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException {
107                    return getService().dynamicQuery(dynamicQuery);
108            }
109    
110            /**
111            * Performs a dynamic query on the database and returns a range of the matching rows.
112            *
113            * <p>
114            * 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.
115            * </p>
116            *
117            * @param dynamicQuery the dynamic query
118            * @param start the lower bound of the range of model instances
119            * @param end the upper bound of the range of model instances (not inclusive)
120            * @return the range of matching rows
121            * @throws SystemException if a system exception occurred
122            */
123            @SuppressWarnings("rawtypes")
124            public static java.util.List dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end) throws com.liferay.portal.kernel.exception.SystemException {
127                    return getService().dynamicQuery(dynamicQuery, start, end);
128            }
129    
130            /**
131            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
132            *
133            * <p>
134            * 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.
135            * </p>
136            *
137            * @param dynamicQuery the dynamic query
138            * @param start the lower bound of the range of model instances
139            * @param end the upper bound of the range of model instances (not inclusive)
140            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
141            * @return the ordered range of matching rows
142            * @throws SystemException if a system exception occurred
143            */
144            @SuppressWarnings("rawtypes")
145            public static java.util.List dynamicQuery(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
147                    int end,
148                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
149                    throws com.liferay.portal.kernel.exception.SystemException {
150                    return getService()
151                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
152            }
153    
154            /**
155            * Returns the number of rows that match the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @return the number of rows that match the dynamic query
159            * @throws SystemException if a system exception occurred
160            */
161            public static long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().dynamicQueryCount(dynamicQuery);
165            }
166    
167            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate fetchDDMTemplate(
168                    long templateId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchDDMTemplate(templateId);
171            }
172    
173            /**
174            * Returns the d d m template with the primary key.
175            *
176            * @param templateId the primary key of the d d m template
177            * @return the d d m template
178            * @throws PortalException if a d d m template with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate getDDMTemplate(
182                    long templateId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getDDMTemplate(templateId);
186            }
187    
188            public static com.liferay.portal.model.PersistedModel getPersistedModel(
189                    java.io.Serializable primaryKeyObj)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException {
192                    return getService().getPersistedModel(primaryKeyObj);
193            }
194    
195            /**
196            * Returns the d d m template with the UUID in the group.
197            *
198            * @param uuid the UUID of d d m template
199            * @param groupId the group id of the d d m template
200            * @return the d d m template
201            * @throws PortalException if a d d m template with the UUID in the group could not be found
202            * @throws SystemException if a system exception occurred
203            */
204            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate getDDMTemplateByUuidAndGroupId(
205                    java.lang.String uuid, long groupId)
206                    throws com.liferay.portal.kernel.exception.PortalException,
207                            com.liferay.portal.kernel.exception.SystemException {
208                    return getService().getDDMTemplateByUuidAndGroupId(uuid, groupId);
209            }
210    
211            /**
212            * Returns a range of all the d d m templates.
213            *
214            * <p>
215            * 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.
216            * </p>
217            *
218            * @param start the lower bound of the range of d d m templates
219            * @param end the upper bound of the range of d d m templates (not inclusive)
220            * @return the range of d d m templates
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getDDMTemplates(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getDDMTemplates(start, end);
227            }
228    
229            /**
230            * Returns the number of d d m templates.
231            *
232            * @return the number of d d m templates
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getDDMTemplatesCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getDDMTemplatesCount();
238            }
239    
240            /**
241            * Updates the d d m template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param ddmTemplate the d d m template
244            * @return the d d m template that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate updateDDMTemplate(
248                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate ddmTemplate)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateDDMTemplate(ddmTemplate);
251            }
252    
253            /**
254            * Updates the d d m template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
255            *
256            * @param ddmTemplate the d d m template
257            * @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.
258            * @return the d d m template that was updated
259            * @throws SystemException if a system exception occurred
260            */
261            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate updateDDMTemplate(
262                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate ddmTemplate,
263                    boolean merge)
264                    throws com.liferay.portal.kernel.exception.SystemException {
265                    return getService().updateDDMTemplate(ddmTemplate, merge);
266            }
267    
268            /**
269            * Returns the Spring bean ID for this bean.
270            *
271            * @return the Spring bean ID for this bean
272            */
273            public static java.lang.String getBeanIdentifier() {
274                    return getService().getBeanIdentifier();
275            }
276    
277            /**
278            * Sets the Spring bean ID for this bean.
279            *
280            * @param beanIdentifier the Spring bean ID for this bean
281            */
282            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
283                    getService().setBeanIdentifier(beanIdentifier);
284            }
285    
286            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate addTemplate(
287                    long userId, long groupId, long structureId,
288                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
289                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
290                    java.lang.String type, java.lang.String mode,
291                    java.lang.String language, java.lang.String script,
292                    com.liferay.portal.service.ServiceContext serviceContext)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException {
295                    return getService()
296                                       .addTemplate(userId, groupId, structureId, nameMap,
297                            descriptionMap, type, mode, language, script, serviceContext);
298            }
299    
300            public static void addTemplateResources(
301                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate template,
302                    boolean addGroupPermissions, boolean addGuestPermissions)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    getService()
306                            .addTemplateResources(template, addGroupPermissions,
307                            addGuestPermissions);
308            }
309    
310            public static void addTemplateResources(
311                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate template,
312                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException {
315                    getService()
316                            .addTemplateResources(template, groupPermissions, guestPermissions);
317            }
318    
319            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> copyTemplates(
320                    long userId, long structureId, long newStructureId,
321                    java.lang.String type,
322                    com.liferay.portal.service.ServiceContext serviceContext)
323                    throws com.liferay.portal.kernel.exception.PortalException,
324                            com.liferay.portal.kernel.exception.SystemException {
325                    return getService()
326                                       .copyTemplates(userId, structureId, newStructureId, type,
327                            serviceContext);
328            }
329    
330            public static void deleteTemplate(
331                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate template)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException {
334                    getService().deleteTemplate(template);
335            }
336    
337            public static void deleteTemplate(long templateId)
338                    throws com.liferay.portal.kernel.exception.PortalException,
339                            com.liferay.portal.kernel.exception.SystemException {
340                    getService().deleteTemplate(templateId);
341            }
342    
343            public static void deleteTemplates(long groupId)
344                    throws com.liferay.portal.kernel.exception.PortalException,
345                            com.liferay.portal.kernel.exception.SystemException {
346                    getService().deleteTemplates(groupId);
347            }
348    
349            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate getTemplate(
350                    long templateId)
351                    throws com.liferay.portal.kernel.exception.PortalException,
352                            com.liferay.portal.kernel.exception.SystemException {
353                    return getService().getTemplate(templateId);
354            }
355    
356            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(
357                    long structureId)
358                    throws com.liferay.portal.kernel.exception.SystemException {
359                    return getService().getTemplates(structureId);
360            }
361    
362            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(
363                    long structureId, java.lang.String type)
364                    throws com.liferay.portal.kernel.exception.SystemException {
365                    return getService().getTemplates(structureId, type);
366            }
367    
368            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(
369                    long structureId, java.lang.String type, java.lang.String mode)
370                    throws com.liferay.portal.kernel.exception.SystemException {
371                    return getService().getTemplates(structureId, type, mode);
372            }
373    
374            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> search(
375                    long companyId, long groupId, long structureId,
376                    java.lang.String keywords, java.lang.String type,
377                    java.lang.String mode, int start, int end,
378                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
379                    throws com.liferay.portal.kernel.exception.SystemException {
380                    return getService()
381                                       .search(companyId, groupId, structureId, keywords, type,
382                            mode, start, end, orderByComparator);
383            }
384    
385            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> search(
386                    long companyId, long groupId, long structureId, java.lang.String name,
387                    java.lang.String description, java.lang.String type,
388                    java.lang.String mode, java.lang.String language, boolean andOperator,
389                    int start, int end,
390                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
391                    throws com.liferay.portal.kernel.exception.SystemException {
392                    return getService()
393                                       .search(companyId, groupId, structureId, name, description,
394                            type, mode, language, andOperator, start, end, orderByComparator);
395            }
396    
397            public static int searchCount(long companyId, long groupId,
398                    long structureId, java.lang.String keywords, java.lang.String type,
399                    java.lang.String mode)
400                    throws com.liferay.portal.kernel.exception.SystemException {
401                    return getService()
402                                       .searchCount(companyId, groupId, structureId, keywords,
403                            type, mode);
404            }
405    
406            public static int searchCount(long companyId, long groupId,
407                    long structureId, java.lang.String name, java.lang.String description,
408                    java.lang.String type, java.lang.String mode,
409                    java.lang.String language, boolean andOperator)
410                    throws com.liferay.portal.kernel.exception.SystemException {
411                    return getService()
412                                       .searchCount(companyId, groupId, structureId, name,
413                            description, type, mode, language, andOperator);
414            }
415    
416            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate updateTemplate(
417                    long templateId,
418                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
419                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
420                    java.lang.String type, java.lang.String mode,
421                    java.lang.String language, java.lang.String script,
422                    com.liferay.portal.service.ServiceContext serviceContext)
423                    throws com.liferay.portal.kernel.exception.PortalException,
424                            com.liferay.portal.kernel.exception.SystemException {
425                    return getService()
426                                       .updateTemplate(templateId, nameMap, descriptionMap, type,
427                            mode, language, script, serviceContext);
428            }
429    
430            public static DDMTemplateLocalService getService() {
431                    if (_service == null) {
432                            _service = (DDMTemplateLocalService)PortalBeanLocatorUtil.locate(DDMTemplateLocalService.class.getName());
433    
434                            ReferenceRegistry.registerReference(DDMTemplateLocalServiceUtil.class,
435                                    "_service");
436                    }
437    
438                    return _service;
439            }
440    
441            /**
442             * @deprecated
443             */
444            public void setService(DDMTemplateLocalService service) {
445            }
446    
447            private static DDMTemplateLocalService _service;
448    }