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.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            * Returns the Spring bean ID for this bean.
255            *
256            * @return the Spring bean ID for this bean
257            */
258            public static java.lang.String getBeanIdentifier() {
259                    return getService().getBeanIdentifier();
260            }
261    
262            /**
263            * Sets the Spring bean ID for this bean.
264            *
265            * @param beanIdentifier the Spring bean ID for this bean
266            */
267            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
268                    getService().setBeanIdentifier(beanIdentifier);
269            }
270    
271            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate addTemplate(
272                    long userId, long groupId, long classNameId, long classPK,
273                    java.lang.String templateKey,
274                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
275                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
276                    java.lang.String type, java.lang.String mode,
277                    java.lang.String language, java.lang.String script, boolean cacheable,
278                    com.liferay.portal.service.ServiceContext serviceContext)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException {
281                    return getService()
282                                       .addTemplate(userId, groupId, classNameId, classPK,
283                            templateKey, nameMap, descriptionMap, type, mode, language, script,
284                            cacheable, serviceContext);
285            }
286    
287            public static void addTemplateResources(
288                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate template,
289                    boolean addGroupPermissions, boolean addGuestPermissions)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    getService()
293                            .addTemplateResources(template, addGroupPermissions,
294                            addGuestPermissions);
295            }
296    
297            public static void addTemplateResources(
298                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate template,
299                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException {
302                    getService()
303                            .addTemplateResources(template, groupPermissions, guestPermissions);
304            }
305    
306            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> copyTemplates(
307                    long userId, long classNameId, long oldClassPK, long newClassPK,
308                    java.lang.String type,
309                    com.liferay.portal.service.ServiceContext serviceContext)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException {
312                    return getService()
313                                       .copyTemplates(userId, classNameId, oldClassPK, newClassPK,
314                            type, serviceContext);
315            }
316    
317            public static void deleteTemplate(
318                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate template)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException {
321                    getService().deleteTemplate(template);
322            }
323    
324            public static void deleteTemplate(long templateId)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException {
327                    getService().deleteTemplate(templateId);
328            }
329    
330            public static void deleteTemplates(long groupId)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException {
333                    getService().deleteTemplates(groupId);
334            }
335    
336            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate fetchTemplate(
337                    long groupId, java.lang.String templateKey)
338                    throws com.liferay.portal.kernel.exception.SystemException {
339                    return getService().fetchTemplate(groupId, templateKey);
340            }
341    
342            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate getTemplate(
343                    long templateId)
344                    throws com.liferay.portal.kernel.exception.PortalException,
345                            com.liferay.portal.kernel.exception.SystemException {
346                    return getService().getTemplate(templateId);
347            }
348    
349            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate getTemplate(
350                    long groupId, java.lang.String templateKey)
351                    throws com.liferay.portal.kernel.exception.PortalException,
352                            com.liferay.portal.kernel.exception.SystemException {
353                    return getService().getTemplate(groupId, templateKey);
354            }
355    
356            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(
357                    long classPK)
358                    throws com.liferay.portal.kernel.exception.SystemException {
359                    return getService().getTemplates(classPK);
360            }
361    
362            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(
363                    long groupId, long classNameId)
364                    throws com.liferay.portal.kernel.exception.SystemException {
365                    return getService().getTemplates(groupId, classNameId);
366            }
367    
368            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(
369                    long groupId, long classNameId, long classPK)
370                    throws com.liferay.portal.kernel.exception.SystemException {
371                    return getService().getTemplates(groupId, classNameId, classPK);
372            }
373    
374            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(
375                    long classNameId, long classPK, java.lang.String type)
376                    throws com.liferay.portal.kernel.exception.SystemException {
377                    return getService().getTemplates(classNameId, classPK, type);
378            }
379    
380            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(
381                    long classNameId, long classPK, java.lang.String type,
382                    java.lang.String mode)
383                    throws com.liferay.portal.kernel.exception.SystemException {
384                    return getService().getTemplates(classNameId, classPK, type, mode);
385            }
386    
387            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> search(
388                    long companyId, long groupId, long classNameId, long classPK,
389                    java.lang.String keywords, java.lang.String type,
390                    java.lang.String mode, int start, int end,
391                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
392                    throws com.liferay.portal.kernel.exception.SystemException {
393                    return getService()
394                                       .search(companyId, groupId, classNameId, classPK, keywords,
395                            type, mode, start, end, orderByComparator);
396            }
397    
398            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> search(
399                    long companyId, long groupId, long classNameId, long classPK,
400                    java.lang.String name, java.lang.String description,
401                    java.lang.String type, java.lang.String mode,
402                    java.lang.String language, boolean andOperator, int start, int end,
403                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
404                    throws com.liferay.portal.kernel.exception.SystemException {
405                    return getService()
406                                       .search(companyId, groupId, classNameId, classPK, name,
407                            description, type, mode, language, andOperator, start, end,
408                            orderByComparator);
409            }
410    
411            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> search(
412                    long companyId, long[] groupIds, long[] classNameIds, long classPK,
413                    java.lang.String keywords, java.lang.String type,
414                    java.lang.String mode, int start, int end,
415                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
416                    throws com.liferay.portal.kernel.exception.SystemException {
417                    return getService()
418                                       .search(companyId, groupIds, classNameIds, classPK,
419                            keywords, type, mode, start, end, orderByComparator);
420            }
421    
422            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> search(
423                    long companyId, long[] groupIds, long[] classNameIds, long classPK,
424                    java.lang.String name, java.lang.String description,
425                    java.lang.String type, java.lang.String mode,
426                    java.lang.String language, boolean andOperator, int start, int end,
427                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
428                    throws com.liferay.portal.kernel.exception.SystemException {
429                    return getService()
430                                       .search(companyId, groupIds, classNameIds, classPK, name,
431                            description, type, mode, language, andOperator, start, end,
432                            orderByComparator);
433            }
434    
435            public static int searchCount(long companyId, long groupId,
436                    long classNameId, long classPK, java.lang.String keywords,
437                    java.lang.String type, java.lang.String mode)
438                    throws com.liferay.portal.kernel.exception.SystemException {
439                    return getService()
440                                       .searchCount(companyId, groupId, classNameId, classPK,
441                            keywords, type, mode);
442            }
443    
444            public static int searchCount(long companyId, long groupId,
445                    long classNameId, long classPK, java.lang.String name,
446                    java.lang.String description, java.lang.String type,
447                    java.lang.String mode, java.lang.String language, boolean andOperator)
448                    throws com.liferay.portal.kernel.exception.SystemException {
449                    return getService()
450                                       .searchCount(companyId, groupId, classNameId, classPK, name,
451                            description, type, mode, language, andOperator);
452            }
453    
454            public static int searchCount(long companyId, long[] groupIds,
455                    long[] classNameIds, long classPK, java.lang.String keywords,
456                    java.lang.String type, java.lang.String mode)
457                    throws com.liferay.portal.kernel.exception.SystemException {
458                    return getService()
459                                       .searchCount(companyId, groupIds, classNameIds, classPK,
460                            keywords, type, mode);
461            }
462    
463            public static int searchCount(long companyId, long[] groupIds,
464                    long[] classNameIds, long classPK, java.lang.String name,
465                    java.lang.String description, java.lang.String type,
466                    java.lang.String mode, java.lang.String language, boolean andOperator)
467                    throws com.liferay.portal.kernel.exception.SystemException {
468                    return getService()
469                                       .searchCount(companyId, groupIds, classNameIds, classPK,
470                            name, description, type, mode, language, andOperator);
471            }
472    
473            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate updateTemplate(
474                    long templateId,
475                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
476                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
477                    java.lang.String type, java.lang.String mode,
478                    java.lang.String language, java.lang.String script, boolean cacheable,
479                    com.liferay.portal.service.ServiceContext serviceContext)
480                    throws com.liferay.portal.kernel.exception.PortalException,
481                            com.liferay.portal.kernel.exception.SystemException {
482                    return getService()
483                                       .updateTemplate(templateId, nameMap, descriptionMap, type,
484                            mode, language, script, cacheable, serviceContext);
485            }
486    
487            public static DDMTemplateLocalService getService() {
488                    if (_service == null) {
489                            _service = (DDMTemplateLocalService)PortalBeanLocatorUtil.locate(DDMTemplateLocalService.class.getName());
490    
491                            ReferenceRegistry.registerReference(DDMTemplateLocalServiceUtil.class,
492                                    "_service");
493                    }
494    
495                    return _service;
496            }
497    
498            /**
499             * @deprecated
500             */
501            public void setService(DDMTemplateLocalService service) {
502            }
503    
504            private static DDMTemplateLocalService _service;
505    }