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