001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate fetchDDMTemplate(
162                    long templateId)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().fetchDDMTemplate(templateId);
165            }
166    
167            /**
168            * Returns the d d m template with the primary key.
169            *
170            * @param templateId the primary key of the d d m template
171            * @return the d d m template
172            * @throws PortalException if a d d m template with the primary key could not be found
173            * @throws SystemException if a system exception occurred
174            */
175            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate getDDMTemplate(
176                    long templateId)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getDDMTemplate(templateId);
180            }
181    
182            public static com.liferay.portal.model.PersistedModel getPersistedModel(
183                    java.io.Serializable primaryKeyObj)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException {
186                    return getService().getPersistedModel(primaryKeyObj);
187            }
188    
189            /**
190            * Returns the d d m template with the UUID in the group.
191            *
192            * @param uuid the UUID of d d m template
193            * @param groupId the group id of the d d m template
194            * @return the d d m template
195            * @throws PortalException if a d d m template with the UUID in the group could not be found
196            * @throws SystemException if a system exception occurred
197            */
198            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate getDDMTemplateByUuidAndGroupId(
199                    java.lang.String uuid, long groupId)
200                    throws com.liferay.portal.kernel.exception.PortalException,
201                            com.liferay.portal.kernel.exception.SystemException {
202                    return getService().getDDMTemplateByUuidAndGroupId(uuid, groupId);
203            }
204    
205            /**
206            * Returns a range of all the d d m templates.
207            *
208            * <p>
209            * 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.
210            * </p>
211            *
212            * @param start the lower bound of the range of d d m templates
213            * @param end the upper bound of the range of d d m templates (not inclusive)
214            * @return the range of d d m templates
215            * @throws SystemException if a system exception occurred
216            */
217            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getDDMTemplates(
218                    int start, int end)
219                    throws com.liferay.portal.kernel.exception.SystemException {
220                    return getService().getDDMTemplates(start, end);
221            }
222    
223            /**
224            * Returns the number of d d m templates.
225            *
226            * @return the number of d d m templates
227            * @throws SystemException if a system exception occurred
228            */
229            public static int getDDMTemplatesCount()
230                    throws com.liferay.portal.kernel.exception.SystemException {
231                    return getService().getDDMTemplatesCount();
232            }
233    
234            /**
235            * Updates the d d m template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
236            *
237            * @param ddmTemplate the d d m template
238            * @return the d d m template that was updated
239            * @throws SystemException if a system exception occurred
240            */
241            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate updateDDMTemplate(
242                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate ddmTemplate)
243                    throws com.liferay.portal.kernel.exception.SystemException {
244                    return getService().updateDDMTemplate(ddmTemplate);
245            }
246    
247            /**
248            * Updates the d d m template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
249            *
250            * @param ddmTemplate the d d m template
251            * @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.
252            * @return the d d m template that was updated
253            * @throws SystemException if a system exception occurred
254            */
255            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate updateDDMTemplate(
256                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate ddmTemplate,
257                    boolean merge)
258                    throws com.liferay.portal.kernel.exception.SystemException {
259                    return getService().updateDDMTemplate(ddmTemplate, merge);
260            }
261    
262            /**
263            * Returns the Spring bean ID for this bean.
264            *
265            * @return the Spring bean ID for this bean
266            */
267            public static java.lang.String getBeanIdentifier() {
268                    return getService().getBeanIdentifier();
269            }
270    
271            /**
272            * Sets the Spring bean ID for this bean.
273            *
274            * @param beanIdentifier the Spring bean ID for this bean
275            */
276            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
277                    getService().setBeanIdentifier(beanIdentifier);
278            }
279    
280            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate addTemplate(
281                    long userId, long groupId, long structureId,
282                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
283                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
284                    java.lang.String type, java.lang.String mode,
285                    java.lang.String language, java.lang.String script,
286                    com.liferay.portal.service.ServiceContext serviceContext)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException {
289                    return getService()
290                                       .addTemplate(userId, groupId, structureId, nameMap,
291                            descriptionMap, type, mode, language, script, serviceContext);
292            }
293    
294            public static void addTemplateResources(
295                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate template,
296                    boolean addGroupPermissions, boolean addGuestPermissions)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException {
299                    getService()
300                            .addTemplateResources(template, addGroupPermissions,
301                            addGuestPermissions);
302            }
303    
304            public static void addTemplateResources(
305                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate template,
306                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException {
309                    getService()
310                            .addTemplateResources(template, groupPermissions, guestPermissions);
311            }
312    
313            public static void deleteTemplate(
314                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate template)
315                    throws com.liferay.portal.kernel.exception.PortalException,
316                            com.liferay.portal.kernel.exception.SystemException {
317                    getService().deleteTemplate(template);
318            }
319    
320            public static void deleteTemplate(long templateId)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException {
323                    getService().deleteTemplate(templateId);
324            }
325    
326            public static void deleteTemplates(long groupId)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException {
329                    getService().deleteTemplates(groupId);
330            }
331    
332            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate getTemplate(
333                    long templateId)
334                    throws com.liferay.portal.kernel.exception.PortalException,
335                            com.liferay.portal.kernel.exception.SystemException {
336                    return getService().getTemplate(templateId);
337            }
338    
339            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(
340                    long structureId)
341                    throws com.liferay.portal.kernel.exception.SystemException {
342                    return getService().getTemplates(structureId);
343            }
344    
345            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(
346                    long structureId, java.lang.String type)
347                    throws com.liferay.portal.kernel.exception.SystemException {
348                    return getService().getTemplates(structureId, type);
349            }
350    
351            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates(
352                    long structureId, java.lang.String type, java.lang.String mode)
353                    throws com.liferay.portal.kernel.exception.SystemException {
354                    return getService().getTemplates(structureId, type, mode);
355            }
356    
357            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> search(
358                    long companyId, long groupId, long structureId,
359                    java.lang.String keywords, java.lang.String type,
360                    java.lang.String mode, 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, keywords, type,
365                            mode, start, end, orderByComparator);
366            }
367    
368            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> search(
369                    long companyId, long groupId, long structureId, java.lang.String name,
370                    java.lang.String description, java.lang.String type,
371                    java.lang.String mode, java.lang.String language, boolean andOperator,
372                    int start, int end,
373                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
374                    throws com.liferay.portal.kernel.exception.SystemException {
375                    return getService()
376                                       .search(companyId, groupId, structureId, name, description,
377                            type, mode, language, andOperator, start, end, orderByComparator);
378            }
379    
380            public static int searchCount(long companyId, long groupId,
381                    long structureId, java.lang.String keywords, java.lang.String type,
382                    java.lang.String mode)
383                    throws com.liferay.portal.kernel.exception.SystemException {
384                    return getService()
385                                       .searchCount(companyId, groupId, structureId, keywords,
386                            type, mode);
387            }
388    
389            public static int searchCount(long companyId, long groupId,
390                    long structureId, java.lang.String name, java.lang.String description,
391                    java.lang.String type, java.lang.String mode,
392                    java.lang.String language, boolean andOperator)
393                    throws com.liferay.portal.kernel.exception.SystemException {
394                    return getService()
395                                       .searchCount(companyId, groupId, structureId, name,
396                            description, type, mode, language, andOperator);
397            }
398    
399            public static com.liferay.portlet.dynamicdatamapping.model.DDMTemplate updateTemplate(
400                    long templateId,
401                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
402                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
403                    java.lang.String type, java.lang.String mode,
404                    java.lang.String language, java.lang.String script,
405                    com.liferay.portal.service.ServiceContext serviceContext)
406                    throws com.liferay.portal.kernel.exception.PortalException,
407                            com.liferay.portal.kernel.exception.SystemException {
408                    return getService()
409                                       .updateTemplate(templateId, nameMap, descriptionMap, type,
410                            mode, language, script, serviceContext);
411            }
412    
413            public static DDMTemplateLocalService getService() {
414                    if (_service == null) {
415                            _service = (DDMTemplateLocalService)PortalBeanLocatorUtil.locate(DDMTemplateLocalService.class.getName());
416    
417                            ReferenceRegistry.registerReference(DDMTemplateLocalServiceUtil.class,
418                                    "_service");
419                            MethodCache.remove(DDMTemplateLocalService.class);
420                    }
421    
422                    return _service;
423            }
424    
425            public void setService(DDMTemplateLocalService service) {
426                    MethodCache.remove(DDMTemplateLocalService.class);
427    
428                    _service = service;
429    
430                    ReferenceRegistry.registerReference(DDMTemplateLocalServiceUtil.class,
431                            "_service");
432                    MethodCache.remove(DDMTemplateLocalService.class);
433            }
434    
435            private static DDMTemplateLocalService _service;
436    }