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.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the d d m structure local service. This utility wraps {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLocalServiceImpl} 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 DDMStructureLocalService
030     * @see com.liferay.portlet.dynamicdatamapping.service.base.DDMStructureLocalServiceBaseImpl
031     * @see com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLocalServiceImpl
032     * @generated
033     */
034    public class DDMStructureLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the d d m structure to the database. Also notifies the appropriate model listeners.
043            *
044            * @param ddmStructure the d d m structure
045            * @return the d d m structure that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure addDDMStructure(
049                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addDDMStructure(ddmStructure);
052            }
053    
054            /**
055            * Creates a new d d m structure with the primary key. Does not add the d d m structure to the database.
056            *
057            * @param structureId the primary key for the new d d m structure
058            * @return the new d d m structure
059            */
060            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure createDDMStructure(
061                    long structureId) {
062                    return getService().createDDMStructure(structureId);
063            }
064    
065            /**
066            * Deletes the d d m structure with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param structureId the primary key of the d d m structure
069            * @throws PortalException if a d d m structure with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteDDMStructure(long structureId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteDDMStructure(structureId);
076            }
077    
078            /**
079            * Deletes the d d m structure from the database. Also notifies the appropriate model listeners.
080            *
081            * @param ddmStructure the d d m structure
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteDDMStructure(
085                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteDDMStructure(ddmStructure);
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.DDMStructure fetchDDMStructure(
162                    long structureId)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().fetchDDMStructure(structureId);
165            }
166    
167            /**
168            * Returns the d d m structure with the primary key.
169            *
170            * @param structureId the primary key of the d d m structure
171            * @return the d d m structure
172            * @throws PortalException if a d d m structure 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.DDMStructure getDDMStructure(
176                    long structureId)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getDDMStructure(structureId);
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 structure with the UUID in the group.
191            *
192            * @param uuid the UUID of d d m structure
193            * @param groupId the group id of the d d m structure
194            * @return the d d m structure
195            * @throws PortalException if a d d m structure 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.DDMStructure getDDMStructureByUuidAndGroupId(
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().getDDMStructureByUuidAndGroupId(uuid, groupId);
203            }
204    
205            /**
206            * Returns a range of all the d d m structures.
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 structures
213            * @param end the upper bound of the range of d d m structures (not inclusive)
214            * @return the range of d d m structures
215            * @throws SystemException if a system exception occurred
216            */
217            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDDMStructures(
218                    int start, int end)
219                    throws com.liferay.portal.kernel.exception.SystemException {
220                    return getService().getDDMStructures(start, end);
221            }
222    
223            /**
224            * Returns the number of d d m structures.
225            *
226            * @return the number of d d m structures
227            * @throws SystemException if a system exception occurred
228            */
229            public static int getDDMStructuresCount()
230                    throws com.liferay.portal.kernel.exception.SystemException {
231                    return getService().getDDMStructuresCount();
232            }
233    
234            /**
235            * Updates the d d m structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
236            *
237            * @param ddmStructure the d d m structure
238            * @return the d d m structure that was updated
239            * @throws SystemException if a system exception occurred
240            */
241            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateDDMStructure(
242                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure)
243                    throws com.liferay.portal.kernel.exception.SystemException {
244                    return getService().updateDDMStructure(ddmStructure);
245            }
246    
247            /**
248            * Updates the d d m structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
249            *
250            * @param ddmStructure the d d m structure
251            * @param merge whether to merge the d d m structure 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 structure that was updated
253            * @throws SystemException if a system exception occurred
254            */
255            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateDDMStructure(
256                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure,
257                    boolean merge)
258                    throws com.liferay.portal.kernel.exception.SystemException {
259                    return getService().updateDDMStructure(ddmStructure, 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.DDMStructure addStructure(
281                    long userId, long groupId, long classNameId,
282                    java.lang.String structureKey,
283                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
284                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
285                    java.lang.String xsd, java.lang.String storageType, int type,
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                                       .addStructure(userId, groupId, classNameId, structureKey,
291                            nameMap, descriptionMap, xsd, storageType, type, serviceContext);
292            }
293    
294            public static void addStructureResources(
295                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure,
296                    boolean addGroupPermissions, boolean addGuestPermissions)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException {
299                    getService()
300                            .addStructureResources(structure, addGroupPermissions,
301                            addGuestPermissions);
302            }
303    
304            public static void addStructureResources(
305                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure,
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                            .addStructureResources(structure, groupPermissions, guestPermissions);
311            }
312    
313            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure copyStructure(
314                    long userId, long structureId,
315                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
316                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
317                    com.liferay.portal.service.ServiceContext serviceContext)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException {
320                    return getService()
321                                       .copyStructure(userId, structureId, nameMap, descriptionMap,
322                            serviceContext);
323            }
324    
325            public static void deleteStructure(
326                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException {
329                    getService().deleteStructure(structure);
330            }
331    
332            public static void deleteStructure(long structureId)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException {
335                    getService().deleteStructure(structureId);
336            }
337    
338            public static void deleteStructure(long groupId,
339                    java.lang.String structureKey)
340                    throws com.liferay.portal.kernel.exception.PortalException,
341                            com.liferay.portal.kernel.exception.SystemException {
342                    getService().deleteStructure(groupId, structureKey);
343            }
344    
345            public static void deleteStructures(long groupId)
346                    throws com.liferay.portal.kernel.exception.PortalException,
347                            com.liferay.portal.kernel.exception.SystemException {
348                    getService().deleteStructures(groupId);
349            }
350    
351            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure(
352                    long structureId)
353                    throws com.liferay.portal.kernel.exception.SystemException {
354                    return getService().fetchStructure(structureId);
355            }
356    
357            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure(
358                    long groupId, java.lang.String structureKey)
359                    throws com.liferay.portal.kernel.exception.SystemException {
360                    return getService().fetchStructure(groupId, structureKey);
361            }
362    
363            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
364                    long classNameId)
365                    throws com.liferay.portal.kernel.exception.SystemException {
366                    return getService().getClassStructures(classNameId);
367            }
368    
369            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
370                    long classNameId, int start, int end)
371                    throws com.liferay.portal.kernel.exception.SystemException {
372                    return getService().getClassStructures(classNameId, start, end);
373            }
374    
375            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
376                    long classNameId,
377                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
378                    throws com.liferay.portal.kernel.exception.SystemException {
379                    return getService().getClassStructures(classNameId, orderByComparator);
380            }
381    
382            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeStructures(
383                    long dlFileEntryTypeId)
384                    throws com.liferay.portal.kernel.exception.SystemException {
385                    return getService().getDLFileEntryTypeStructures(dlFileEntryTypeId);
386            }
387    
388            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure(
389                    long structureId)
390                    throws com.liferay.portal.kernel.exception.PortalException,
391                            com.liferay.portal.kernel.exception.SystemException {
392                    return getService().getStructure(structureId);
393            }
394    
395            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure(
396                    long groupId, java.lang.String structureKey)
397                    throws com.liferay.portal.kernel.exception.PortalException,
398                            com.liferay.portal.kernel.exception.SystemException {
399                    return getService().getStructure(groupId, structureKey);
400            }
401    
402            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructure(
403                    long groupId, java.lang.String name, java.lang.String description)
404                    throws com.liferay.portal.kernel.exception.SystemException {
405                    return getService().getStructure(groupId, name, description);
406            }
407    
408            /**
409            * @deprecated {@link #getStructures}
410            */
411            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries()
412                    throws com.liferay.portal.kernel.exception.SystemException {
413                    return getService().getStructureEntries();
414            }
415    
416            /**
417            * @deprecated {@link #getStructures(long)}
418            */
419            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries(
420                    long groupId)
421                    throws com.liferay.portal.kernel.exception.SystemException {
422                    return getService().getStructureEntries(groupId);
423            }
424    
425            /**
426            * @deprecated {@link #getStructures(long, int, int)}
427            */
428            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries(
429                    long groupId, int start, int end)
430                    throws com.liferay.portal.kernel.exception.SystemException {
431                    return getService().getStructureEntries(groupId, start, end);
432            }
433    
434            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures()
435                    throws com.liferay.portal.kernel.exception.SystemException {
436                    return getService().getStructures();
437            }
438    
439            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures(
440                    long groupId)
441                    throws com.liferay.portal.kernel.exception.SystemException {
442                    return getService().getStructures(groupId);
443            }
444    
445            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures(
446                    long groupId, int start, int end)
447                    throws com.liferay.portal.kernel.exception.SystemException {
448                    return getService().getStructures(groupId, start, end);
449            }
450    
451            public static int getStructuresCount(long groupId)
452                    throws com.liferay.portal.kernel.exception.SystemException {
453                    return getService().getStructuresCount(groupId);
454            }
455    
456            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> search(
457                    long companyId, long[] groupIds, long[] classNameIds,
458                    java.lang.String keywords, int start, int end,
459                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
460                    throws com.liferay.portal.kernel.exception.SystemException {
461                    return getService()
462                                       .search(companyId, groupIds, classNameIds, keywords, start,
463                            end, orderByComparator);
464            }
465    
466            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> search(
467                    long companyId, long[] groupIds, long[] classNameIds,
468                    java.lang.String name, java.lang.String description,
469                    java.lang.String storageType, int type, boolean andOperator, int start,
470                    int end,
471                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
472                    throws com.liferay.portal.kernel.exception.SystemException {
473                    return getService()
474                                       .search(companyId, groupIds, classNameIds, name,
475                            description, storageType, type, andOperator, start, end,
476                            orderByComparator);
477            }
478    
479            public static int searchCount(long companyId, long[] groupIds,
480                    long[] classNameIds, java.lang.String keywords)
481                    throws com.liferay.portal.kernel.exception.SystemException {
482                    return getService()
483                                       .searchCount(companyId, groupIds, classNameIds, keywords);
484            }
485    
486            public static int searchCount(long companyId, long[] groupIds,
487                    long[] classNameIds, java.lang.String name,
488                    java.lang.String description, java.lang.String storageType, int type,
489                    boolean andOperator)
490                    throws com.liferay.portal.kernel.exception.SystemException {
491                    return getService()
492                                       .searchCount(companyId, groupIds, classNameIds, name,
493                            description, storageType, type, andOperator);
494            }
495    
496            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure(
497                    long structureId,
498                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
499                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
500                    java.lang.String xsd,
501                    com.liferay.portal.service.ServiceContext serviceContext)
502                    throws com.liferay.portal.kernel.exception.PortalException,
503                            com.liferay.portal.kernel.exception.SystemException {
504                    return getService()
505                                       .updateStructure(structureId, nameMap, descriptionMap, xsd,
506                            serviceContext);
507            }
508    
509            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure(
510                    long groupId, java.lang.String structureKey,
511                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
512                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
513                    java.lang.String xsd,
514                    com.liferay.portal.service.ServiceContext serviceContext)
515                    throws com.liferay.portal.kernel.exception.PortalException,
516                            com.liferay.portal.kernel.exception.SystemException {
517                    return getService()
518                                       .updateStructure(groupId, structureKey, nameMap,
519                            descriptionMap, xsd, serviceContext);
520            }
521    
522            public static DDMStructureLocalService getService() {
523                    if (_service == null) {
524                            _service = (DDMStructureLocalService)PortalBeanLocatorUtil.locate(DDMStructureLocalService.class.getName());
525    
526                            ReferenceRegistry.registerReference(DDMStructureLocalServiceUtil.class,
527                                    "_service");
528                            MethodCache.remove(DDMStructureLocalService.class);
529                    }
530    
531                    return _service;
532            }
533    
534            public void setService(DDMStructureLocalService service) {
535                    MethodCache.remove(DDMStructureLocalService.class);
536    
537                    _service = service;
538    
539                    ReferenceRegistry.registerReference(DDMStructureLocalServiceUtil.class,
540                            "_service");
541                    MethodCache.remove(DDMStructureLocalService.class);
542            }
543    
544            private static DDMStructureLocalService _service;
545    }