001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.dynamicdatamapping.service;
016    
017    import com.liferay.portal.service.ServiceWrapper;
018    
019    /**
020     * <p>
021     * This class is a wrapper for {@link DDMStructureLocalService}.
022     * </p>
023     *
024     * @author    Brian Wing Shun Chan
025     * @see       DDMStructureLocalService
026     * @generated
027     */
028    public class DDMStructureLocalServiceWrapper implements DDMStructureLocalService,
029            ServiceWrapper<DDMStructureLocalService> {
030            public DDMStructureLocalServiceWrapper(
031                    DDMStructureLocalService ddmStructureLocalService) {
032                    _ddmStructureLocalService = ddmStructureLocalService;
033            }
034    
035            /**
036            * Adds the d d m structure to the database. Also notifies the appropriate model listeners.
037            *
038            * @param ddmStructure the d d m structure
039            * @return the d d m structure that was added
040            * @throws SystemException if a system exception occurred
041            */
042            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addDDMStructure(
043                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure)
044                    throws com.liferay.portal.kernel.exception.SystemException {
045                    return _ddmStructureLocalService.addDDMStructure(ddmStructure);
046            }
047    
048            /**
049            * Creates a new d d m structure with the primary key. Does not add the d d m structure to the database.
050            *
051            * @param structureId the primary key for the new d d m structure
052            * @return the new d d m structure
053            */
054            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure createDDMStructure(
055                    long structureId) {
056                    return _ddmStructureLocalService.createDDMStructure(structureId);
057            }
058    
059            /**
060            * Deletes the d d m structure with the primary key from the database. Also notifies the appropriate model listeners.
061            *
062            * @param structureId the primary key of the d d m structure
063            * @return the d d m structure that was removed
064            * @throws PortalException if a d d m structure with the primary key could not be found
065            * @throws SystemException if a system exception occurred
066            */
067            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure deleteDDMStructure(
068                    long structureId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    return _ddmStructureLocalService.deleteDDMStructure(structureId);
072            }
073    
074            /**
075            * Deletes the d d m structure from the database. Also notifies the appropriate model listeners.
076            *
077            * @param ddmStructure the d d m structure
078            * @return the d d m structure that was removed
079            * @throws SystemException if a system exception occurred
080            */
081            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure deleteDDMStructure(
082                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure)
083                    throws com.liferay.portal.kernel.exception.SystemException {
084                    return _ddmStructureLocalService.deleteDDMStructure(ddmStructure);
085            }
086    
087            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
088                    return _ddmStructureLocalService.dynamicQuery();
089            }
090    
091            /**
092            * Performs a dynamic query on the database and returns the matching rows.
093            *
094            * @param dynamicQuery the dynamic query
095            * @return the matching rows
096            * @throws SystemException if a system exception occurred
097            */
098            @SuppressWarnings("rawtypes")
099            public java.util.List dynamicQuery(
100                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
101                    throws com.liferay.portal.kernel.exception.SystemException {
102                    return _ddmStructureLocalService.dynamicQuery(dynamicQuery);
103            }
104    
105            /**
106            * Performs a dynamic query on the database and returns a range of the matching rows.
107            *
108            * <p>
109            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
110            * </p>
111            *
112            * @param dynamicQuery the dynamic query
113            * @param start the lower bound of the range of model instances
114            * @param end the upper bound of the range of model instances (not inclusive)
115            * @return the range of matching rows
116            * @throws SystemException if a system exception occurred
117            */
118            @SuppressWarnings("rawtypes")
119            public java.util.List dynamicQuery(
120                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
121                    int end) throws com.liferay.portal.kernel.exception.SystemException {
122                    return _ddmStructureLocalService.dynamicQuery(dynamicQuery, start, end);
123            }
124    
125            /**
126            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
127            *
128            * <p>
129            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
130            * </p>
131            *
132            * @param dynamicQuery the dynamic query
133            * @param start the lower bound of the range of model instances
134            * @param end the upper bound of the range of model instances (not inclusive)
135            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
136            * @return the ordered range of matching rows
137            * @throws SystemException if a system exception occurred
138            */
139            @SuppressWarnings("rawtypes")
140            public java.util.List dynamicQuery(
141                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
142                    int end,
143                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
144                    throws com.liferay.portal.kernel.exception.SystemException {
145                    return _ddmStructureLocalService.dynamicQuery(dynamicQuery, start, end,
146                            orderByComparator);
147            }
148    
149            /**
150            * Returns the number of rows that match the dynamic query.
151            *
152            * @param dynamicQuery the dynamic query
153            * @return the number of rows that match the dynamic query
154            * @throws SystemException if a system exception occurred
155            */
156            public long dynamicQueryCount(
157                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
158                    throws com.liferay.portal.kernel.exception.SystemException {
159                    return _ddmStructureLocalService.dynamicQueryCount(dynamicQuery);
160            }
161    
162            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchDDMStructure(
163                    long structureId)
164                    throws com.liferay.portal.kernel.exception.SystemException {
165                    return _ddmStructureLocalService.fetchDDMStructure(structureId);
166            }
167    
168            /**
169            * Returns the d d m structure with the primary key.
170            *
171            * @param structureId the primary key of the d d m structure
172            * @return the d d m structure
173            * @throws PortalException if a d d m structure with the primary key could not be found
174            * @throws SystemException if a system exception occurred
175            */
176            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getDDMStructure(
177                    long structureId)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return _ddmStructureLocalService.getDDMStructure(structureId);
181            }
182    
183            public com.liferay.portal.model.PersistedModel getPersistedModel(
184                    java.io.Serializable primaryKeyObj)
185                    throws com.liferay.portal.kernel.exception.PortalException,
186                            com.liferay.portal.kernel.exception.SystemException {
187                    return _ddmStructureLocalService.getPersistedModel(primaryKeyObj);
188            }
189    
190            /**
191            * Returns the d d m structure matching the UUID and group.
192            *
193            * @param uuid the d d m structure's UUID
194            * @param groupId the primary key of the group
195            * @return the matching d d m structure
196            * @throws PortalException if a matching d d m structure could not be found
197            * @throws SystemException if a system exception occurred
198            */
199            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getDDMStructureByUuidAndGroupId(
200                    java.lang.String uuid, long groupId)
201                    throws com.liferay.portal.kernel.exception.PortalException,
202                            com.liferay.portal.kernel.exception.SystemException {
203                    return _ddmStructureLocalService.getDDMStructureByUuidAndGroupId(uuid,
204                            groupId);
205            }
206    
207            /**
208            * Returns a range of all the d d m structures.
209            *
210            * <p>
211            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
212            * </p>
213            *
214            * @param start the lower bound of the range of d d m structures
215            * @param end the upper bound of the range of d d m structures (not inclusive)
216            * @return the range of d d m structures
217            * @throws SystemException if a system exception occurred
218            */
219            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDDMStructures(
220                    int start, int end)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return _ddmStructureLocalService.getDDMStructures(start, end);
223            }
224    
225            /**
226            * Returns the number of d d m structures.
227            *
228            * @return the number of d d m structures
229            * @throws SystemException if a system exception occurred
230            */
231            public int getDDMStructuresCount()
232                    throws com.liferay.portal.kernel.exception.SystemException {
233                    return _ddmStructureLocalService.getDDMStructuresCount();
234            }
235    
236            /**
237            * Updates the d d m structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
238            *
239            * @param ddmStructure the d d m structure
240            * @return the d d m structure that was updated
241            * @throws SystemException if a system exception occurred
242            */
243            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateDDMStructure(
244                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure)
245                    throws com.liferay.portal.kernel.exception.SystemException {
246                    return _ddmStructureLocalService.updateDDMStructure(ddmStructure);
247            }
248    
249            /**
250            * @throws SystemException if a system exception occurred
251            */
252            public void addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
253                    long structureId)
254                    throws com.liferay.portal.kernel.exception.SystemException {
255                    _ddmStructureLocalService.addDLFileEntryTypeDDMStructure(fileEntryTypeId,
256                            structureId);
257            }
258    
259            /**
260            * @throws SystemException if a system exception occurred
261            */
262            public void addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
263                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure)
264                    throws com.liferay.portal.kernel.exception.SystemException {
265                    _ddmStructureLocalService.addDLFileEntryTypeDDMStructure(fileEntryTypeId,
266                            ddmStructure);
267            }
268    
269            /**
270            * @throws SystemException if a system exception occurred
271            */
272            public void addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
273                    long[] structureIds)
274                    throws com.liferay.portal.kernel.exception.SystemException {
275                    _ddmStructureLocalService.addDLFileEntryTypeDDMStructures(fileEntryTypeId,
276                            structureIds);
277            }
278    
279            /**
280            * @throws SystemException if a system exception occurred
281            */
282            public void addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
283                    java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> DDMStructures)
284                    throws com.liferay.portal.kernel.exception.SystemException {
285                    _ddmStructureLocalService.addDLFileEntryTypeDDMStructures(fileEntryTypeId,
286                            DDMStructures);
287            }
288    
289            /**
290            * @throws SystemException if a system exception occurred
291            */
292            public void clearDLFileEntryTypeDDMStructures(long fileEntryTypeId)
293                    throws com.liferay.portal.kernel.exception.SystemException {
294                    _ddmStructureLocalService.clearDLFileEntryTypeDDMStructures(fileEntryTypeId);
295            }
296    
297            /**
298            * @throws SystemException if a system exception occurred
299            */
300            public void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
301                    long structureId)
302                    throws com.liferay.portal.kernel.exception.SystemException {
303                    _ddmStructureLocalService.deleteDLFileEntryTypeDDMStructure(fileEntryTypeId,
304                            structureId);
305            }
306    
307            /**
308            * @throws SystemException if a system exception occurred
309            */
310            public void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
311                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure)
312                    throws com.liferay.portal.kernel.exception.SystemException {
313                    _ddmStructureLocalService.deleteDLFileEntryTypeDDMStructure(fileEntryTypeId,
314                            ddmStructure);
315            }
316    
317            /**
318            * @throws SystemException if a system exception occurred
319            */
320            public void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
321                    long[] structureIds)
322                    throws com.liferay.portal.kernel.exception.SystemException {
323                    _ddmStructureLocalService.deleteDLFileEntryTypeDDMStructures(fileEntryTypeId,
324                            structureIds);
325            }
326    
327            /**
328            * @throws SystemException if a system exception occurred
329            */
330            public void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
331                    java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> DDMStructures)
332                    throws com.liferay.portal.kernel.exception.SystemException {
333                    _ddmStructureLocalService.deleteDLFileEntryTypeDDMStructures(fileEntryTypeId,
334                            DDMStructures);
335            }
336    
337            /**
338            * @throws SystemException if a system exception occurred
339            */
340            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeDDMStructures(
341                    long fileEntryTypeId)
342                    throws com.liferay.portal.kernel.exception.SystemException {
343                    return _ddmStructureLocalService.getDLFileEntryTypeDDMStructures(fileEntryTypeId);
344            }
345    
346            /**
347            * @throws SystemException if a system exception occurred
348            */
349            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeDDMStructures(
350                    long fileEntryTypeId, int start, int end)
351                    throws com.liferay.portal.kernel.exception.SystemException {
352                    return _ddmStructureLocalService.getDLFileEntryTypeDDMStructures(fileEntryTypeId,
353                            start, end);
354            }
355    
356            /**
357            * @throws SystemException if a system exception occurred
358            */
359            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeDDMStructures(
360                    long fileEntryTypeId, int start, int end,
361                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
362                    throws com.liferay.portal.kernel.exception.SystemException {
363                    return _ddmStructureLocalService.getDLFileEntryTypeDDMStructures(fileEntryTypeId,
364                            start, end, orderByComparator);
365            }
366    
367            /**
368            * @throws SystemException if a system exception occurred
369            */
370            public int getDLFileEntryTypeDDMStructuresCount(long fileEntryTypeId)
371                    throws com.liferay.portal.kernel.exception.SystemException {
372                    return _ddmStructureLocalService.getDLFileEntryTypeDDMStructuresCount(fileEntryTypeId);
373            }
374    
375            /**
376            * @throws SystemException if a system exception occurred
377            */
378            public boolean hasDLFileEntryTypeDDMStructure(long fileEntryTypeId,
379                    long structureId)
380                    throws com.liferay.portal.kernel.exception.SystemException {
381                    return _ddmStructureLocalService.hasDLFileEntryTypeDDMStructure(fileEntryTypeId,
382                            structureId);
383            }
384    
385            /**
386            * @throws SystemException if a system exception occurred
387            */
388            public boolean hasDLFileEntryTypeDDMStructures(long fileEntryTypeId)
389                    throws com.liferay.portal.kernel.exception.SystemException {
390                    return _ddmStructureLocalService.hasDLFileEntryTypeDDMStructures(fileEntryTypeId);
391            }
392    
393            /**
394            * @throws SystemException if a system exception occurred
395            */
396            public void setDLFileEntryTypeDDMStructures(long fileEntryTypeId,
397                    long[] structureIds)
398                    throws com.liferay.portal.kernel.exception.SystemException {
399                    _ddmStructureLocalService.setDLFileEntryTypeDDMStructures(fileEntryTypeId,
400                            structureIds);
401            }
402    
403            /**
404            * Returns the Spring bean ID for this bean.
405            *
406            * @return the Spring bean ID for this bean
407            */
408            public java.lang.String getBeanIdentifier() {
409                    return _ddmStructureLocalService.getBeanIdentifier();
410            }
411    
412            /**
413            * Sets the Spring bean ID for this bean.
414            *
415            * @param beanIdentifier the Spring bean ID for this bean
416            */
417            public void setBeanIdentifier(java.lang.String beanIdentifier) {
418                    _ddmStructureLocalService.setBeanIdentifier(beanIdentifier);
419            }
420    
421            /**
422            * Adds a structure referencing its parent structure.
423            *
424            * @param userId the primary key of the structure's creator/owner
425            * @param groupId the primary key of the group
426            * @param parentStructureId the primary key of the parent structure
427            (optionally {@link
428            com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants#DEFAULT_PARENT_STRUCTURE_ID})
429            * @param classNameId the primary key of the class name for the structure's
430            related model
431            * @param structureKey the unique string identifying the structure
432            (optionally <code>null</code>)
433            * @param nameMap the structure's locales and localized names
434            * @param descriptionMap the structure's locales and localized descriptions
435            * @param xsd the structure's XML schema definition
436            * @param storageType the structure's storage type. It can be "xml" or
437            "expando". For more information, see {@link
438            com.liferay.portlet.dynamicdatamapping.storage.StorageType}.
439            * @param type the structure's type. For more information, see {@link
440            com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}.
441            * @param serviceContext the service context to be applied. Can set the
442            UUID, creation date, modification date, guest permissions, and
443            group permissions for the structure.
444            * @return the structure
445            * @throws PortalException if a user with the primary key could not be
446            found, if the XSD was not well-formed, or if a portal exception
447            occurred
448            * @throws SystemException if a system exception occurred
449            */
450            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addStructure(
451                    long userId, long groupId, long parentStructureId, long classNameId,
452                    java.lang.String structureKey,
453                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
454                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
455                    java.lang.String xsd, java.lang.String storageType, int type,
456                    com.liferay.portal.service.ServiceContext serviceContext)
457                    throws com.liferay.portal.kernel.exception.PortalException,
458                            com.liferay.portal.kernel.exception.SystemException {
459                    return _ddmStructureLocalService.addStructure(userId, groupId,
460                            parentStructureId, classNameId, structureKey, nameMap,
461                            descriptionMap, xsd, storageType, type, serviceContext);
462            }
463    
464            /**
465            * Adds a structure referencing a default parent structure, using the portal
466            * property <code>dynamic.data.lists.storage.type</code> storage type and
467            * default structure type.
468            *
469            * @param userId the primary key of the structure's creator/owner
470            * @param groupId the primary key of the group
471            * @param classNameId the primary key of the class name for the structure's
472            related model
473            * @param nameMap the structure's locales and localized names
474            * @param descriptionMap the structure's locales and localized descriptions
475            * @param xsd the structure's XML schema definition
476            * @param serviceContext the service context to be applied. Can set the
477            UUID, creation date, modification date, guest permissions, and
478            group permissions for the structure.
479            * @return the structure
480            * @throws PortalException if a user with the primary key could not be
481            found, if the XSD was not well-formed, or if a portal exception
482            occurred
483            * @throws SystemException if a system exception occurred
484            */
485            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addStructure(
486                    long userId, long groupId, long classNameId,
487                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
488                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
489                    java.lang.String xsd,
490                    com.liferay.portal.service.ServiceContext serviceContext)
491                    throws com.liferay.portal.kernel.exception.PortalException,
492                            com.liferay.portal.kernel.exception.SystemException {
493                    return _ddmStructureLocalService.addStructure(userId, groupId,
494                            classNameId, nameMap, descriptionMap, xsd, serviceContext);
495            }
496    
497            /**
498            * Adds a structure referencing a default parent structure if the parent
499            * structure is not found.
500            *
501            * @param userId the primary key of the structure's creator/owner
502            * @param groupId the primary key of the group
503            * @param parentStructureKey the unique string identifying the parent
504            structure (optionally <code>null</code>)
505            * @param classNameId the primary key of the class name for the structure's
506            related model
507            * @param structureKey the unique string identifying the structure
508            (optionally <code>null</code>)
509            * @param nameMap the structure's locales and localized names
510            * @param descriptionMap the structure's locales and localized descriptions
511            * @param xsd the structure's XML schema definition
512            * @param storageType the structure's storage type. It can be "xml" or
513            "expando". For more information, see {@link
514            com.liferay.portlet.dynamicdatamapping.storage.StorageType}.
515            * @param type the structure's type. For more information, see {@link
516            com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}.
517            * @param serviceContext the service context to be applied. Can set the
518            UUID, creation date, modification date, guest permissions and
519            group permissions for the structure.
520            * @return the structure
521            * @throws PortalException if a user with the primary key could not be
522            found, if the XSD was not well-formed, or if a portal exception
523            occurred
524            * @throws SystemException if a system exception occurred
525            */
526            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addStructure(
527                    long userId, long groupId, java.lang.String parentStructureKey,
528                    long classNameId, java.lang.String structureKey,
529                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
530                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
531                    java.lang.String xsd, java.lang.String storageType, int type,
532                    com.liferay.portal.service.ServiceContext serviceContext)
533                    throws com.liferay.portal.kernel.exception.PortalException,
534                            com.liferay.portal.kernel.exception.SystemException {
535                    return _ddmStructureLocalService.addStructure(userId, groupId,
536                            parentStructureKey, classNameId, structureKey, nameMap,
537                            descriptionMap, xsd, storageType, type, serviceContext);
538            }
539    
540            /**
541            * Adds the resources to the structure.
542            *
543            * @param structure the structure to add resources to
544            * @param addGroupPermissions whether to add group permissions
545            * @param addGuestPermissions whether to add guest permissions
546            * @throws PortalException if a portal exception occurred
547            * @throws SystemException if a system exception occurred
548            */
549            public void addStructureResources(
550                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure,
551                    boolean addGroupPermissions, boolean addGuestPermissions)
552                    throws com.liferay.portal.kernel.exception.PortalException,
553                            com.liferay.portal.kernel.exception.SystemException {
554                    _ddmStructureLocalService.addStructureResources(structure,
555                            addGroupPermissions, addGuestPermissions);
556            }
557    
558            /**
559            * Adds the model resources with the permissions to the structure.
560            *
561            * @param structure the structure to add resources to
562            * @param groupPermissions the group permissions to be added
563            * @param guestPermissions the guest permissions to be added
564            * @throws PortalException if a portal exception occurred
565            * @throws SystemException if a system exception occurred
566            */
567            public void addStructureResources(
568                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure,
569                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
570                    throws com.liferay.portal.kernel.exception.PortalException,
571                            com.liferay.portal.kernel.exception.SystemException {
572                    _ddmStructureLocalService.addStructureResources(structure,
573                            groupPermissions, guestPermissions);
574            }
575    
576            /**
577            * Copies a structure, creating a new structure with all the values
578            * extracted from the original one. The new structure supports a new name
579            * and description.
580            *
581            * @param userId the primary key of the structure's creator/owner
582            * @param structureId the primary key of the structure to be copied
583            * @param nameMap the new structure's locales and localized names
584            * @param descriptionMap the new structure's locales and localized
585            descriptions
586            * @param serviceContext the service context to be applied. Can set the
587            UUID, creation date, modification date, guest permissions, and
588            group permissions for the structure.
589            * @return the new structure
590            * @throws PortalException if a portal exception occurred
591            * @throws SystemException if a system exception occurred
592            */
593            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure copyStructure(
594                    long userId, long structureId,
595                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
596                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
597                    com.liferay.portal.service.ServiceContext serviceContext)
598                    throws com.liferay.portal.kernel.exception.PortalException,
599                            com.liferay.portal.kernel.exception.SystemException {
600                    return _ddmStructureLocalService.copyStructure(userId, structureId,
601                            nameMap, descriptionMap, serviceContext);
602            }
603    
604            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure copyStructure(
605                    long userId, long structureId,
606                    com.liferay.portal.service.ServiceContext serviceContext)
607                    throws com.liferay.portal.kernel.exception.PortalException,
608                            com.liferay.portal.kernel.exception.SystemException {
609                    return _ddmStructureLocalService.copyStructure(userId, structureId,
610                            serviceContext);
611            }
612    
613            /**
614            * Deletes the structure and its resources.
615            *
616            * <p>
617            * Before deleting the structure, this method verifies whether the structure
618            * is required by another entity. If it is needed, an exception is thrown.
619            * </p>
620            *
621            * @param structure the structure to be deleted
622            * @throws PortalException if a portal exception occurred
623            * @throws SystemException if a system exception occurred
624            */
625            public void deleteStructure(
626                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure)
627                    throws com.liferay.portal.kernel.exception.PortalException,
628                            com.liferay.portal.kernel.exception.SystemException {
629                    _ddmStructureLocalService.deleteStructure(structure);
630            }
631    
632            /**
633            * Deletes the structure and its resources.
634            *
635            * <p>
636            * Before deleting the structure, the system verifies whether the structure
637            * is required by another entity. If it is needed, an exception is thrown.
638            * </p>
639            *
640            * @param structureId the primary key of the structure to be deleted
641            * @throws PortalException if a portal exception occurred
642            * @throws SystemException if a system exception occurred
643            */
644            public void deleteStructure(long structureId)
645                    throws com.liferay.portal.kernel.exception.PortalException,
646                            com.liferay.portal.kernel.exception.SystemException {
647                    _ddmStructureLocalService.deleteStructure(structureId);
648            }
649    
650            /**
651            * Deletes the matching structure and its resources.
652            *
653            * <p>
654            * Before deleting the structure, the system verifies whether the structure
655            * is required by another entity. If it is needed, an exception is thrown.
656            * </p>
657            *
658            * @param groupId the primary key of the group
659            * @param classNameId the primary key of the class name for the structure's
660            related model
661            * @param structureKey the unique string identifying the structure
662            * @throws PortalException if a portal exception occurred
663            * @throws SystemException if a system exception occurred
664            */
665            public void deleteStructure(long groupId, long classNameId,
666                    java.lang.String structureKey)
667                    throws com.liferay.portal.kernel.exception.PortalException,
668                            com.liferay.portal.kernel.exception.SystemException {
669                    _ddmStructureLocalService.deleteStructure(groupId, classNameId,
670                            structureKey);
671            }
672    
673            /**
674            * Deletes all the structures of the group.
675            *
676            * <p>
677            * Before deleting the structures, the system verifies whether each
678            * structure is required by another entity. If any of the structures are
679            * needed, an exception is thrown.
680            * </p>
681            *
682            * @param groupId the primary key of the group
683            * @throws PortalException if a portal exception occurred
684            * @throws SystemException if a system exception occurred
685            */
686            public void deleteStructures(long groupId)
687                    throws com.liferay.portal.kernel.exception.PortalException,
688                            com.liferay.portal.kernel.exception.SystemException {
689                    _ddmStructureLocalService.deleteStructures(groupId);
690            }
691    
692            /**
693            * Returns the structure with the ID.
694            *
695            * @param structureId the primary key of the structure
696            * @return the structure with the structure ID, or <code>null</code> if a
697            matching structure could not be found
698            * @throws SystemException if a system exception occurred
699            */
700            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure(
701                    long structureId)
702                    throws com.liferay.portal.kernel.exception.SystemException {
703                    return _ddmStructureLocalService.fetchStructure(structureId);
704            }
705    
706            /**
707            * Returns the structure matching the class name ID, structure key, and
708            * group.
709            *
710            * @param groupId the primary key of the group
711            * @param classNameId the primary key of the class name for the structure's
712            related model
713            * @param structureKey the unique string identifying the structure
714            * @return the matching structure, or <code>null</code> if a matching
715            structure could not be found
716            * @throws SystemException if a system exception occurred
717            */
718            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure(
719                    long groupId, long classNameId, java.lang.String structureKey)
720                    throws com.liferay.portal.kernel.exception.SystemException {
721                    return _ddmStructureLocalService.fetchStructure(groupId, classNameId,
722                            structureKey);
723            }
724    
725            /**
726            * Returns the structure matching the class name ID, structure key, and
727            * group, optionally in the global scope.
728            *
729            * <p>
730            * This method first searches in the group. If the structure is still not
731            * found and <code>includeGlobalStructures</code> is set to
732            * <code>true</code>, this method searches the global group.
733            * </p>
734            *
735            * @param groupId the primary key of the group
736            * @param classNameId the primary key of the class name for the structure's
737            related model
738            * @param structureKey the unique string identifying the structure
739            * @param includeGlobalStructures whether to include the global scope in
740            the search
741            * @return the matching structure, or <code>null</code> if a matching
742            structure could not be found
743            * @throws PortalException if a portal exception occurred
744            * @throws SystemException if a system exception occurred
745            */
746            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure(
747                    long groupId, long classNameId, java.lang.String structureKey,
748                    boolean includeGlobalStructures)
749                    throws com.liferay.portal.kernel.exception.PortalException,
750                            com.liferay.portal.kernel.exception.SystemException {
751                    return _ddmStructureLocalService.fetchStructure(groupId, classNameId,
752                            structureKey, includeGlobalStructures);
753            }
754    
755            /**
756            * Returns the structure matching the UUID and group.
757            *
758            * @param uuid the structure's UUID
759            * @param groupId the primary key of the structure's group
760            * @return the matching structure, or <code>null</code> if a matching
761            structure could not be found
762            * @throws SystemException if a system exception occurred
763            */
764            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure(
765                    java.lang.String uuid, long groupId)
766                    throws com.liferay.portal.kernel.exception.SystemException {
767                    return _ddmStructureLocalService.fetchStructure(uuid, groupId);
768            }
769    
770            /**
771            * @deprecated As of 6.2.0, replaced by {@link #getClassStructures(long,
772            long)}
773            */
774            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
775                    long classNameId)
776                    throws com.liferay.portal.kernel.exception.SystemException {
777                    return _ddmStructureLocalService.getClassStructures(classNameId);
778            }
779    
780            /**
781            * @deprecated As of 6.2.0, replaced by {@link #getClassStructures(long,
782            long, int, int)}
783            */
784            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
785                    long classNameId, int start, int end)
786                    throws com.liferay.portal.kernel.exception.SystemException {
787                    return _ddmStructureLocalService.getClassStructures(classNameId, start,
788                            end);
789            }
790    
791            /**
792            * Returns all the structures matching the class name ID.
793            *
794            * @param companyId the primary key of the structure's company
795            * @param classNameId the primary key of the class name for the structure's
796            related model
797            * @return the structures matching the class name ID
798            * @throws SystemException if a system exception occurred
799            */
800            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
801                    long companyId, long classNameId)
802                    throws com.liferay.portal.kernel.exception.SystemException {
803                    return _ddmStructureLocalService.getClassStructures(companyId,
804                            classNameId);
805            }
806    
807            /**
808            * Returns a range of all the structures matching the class name ID.
809            *
810            * <p>
811            * Useful when paginating results. Returns a maximum of <code>end -
812            * start</code> instances. <code>start</code> and <code>end</code> are not
813            * primary keys, they are indexes in the result set. Thus, <code>0</code>
814            * refers to the first result in the set. Setting both <code>start</code>
815            * and <code>end</code> to {@link
816            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
817            * result set.
818            * </p>
819            *
820            * @param companyId the primary key of the structure's company
821            * @param classNameId the primary key of the class name for the structure's
822            related model
823            * @param start the lower bound of the range of structures to return
824            * @param end the upper bound of the range of structures to return (not
825            inclusive)
826            * @return the range of matching structures
827            * @throws SystemException if a system exception occurred
828            */
829            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
830                    long companyId, long classNameId, int start, int end)
831                    throws com.liferay.portal.kernel.exception.SystemException {
832                    return _ddmStructureLocalService.getClassStructures(companyId,
833                            classNameId, start, end);
834            }
835    
836            /**
837            * Returns all the structures matching the class name ID ordered by the
838            * comparator.
839            *
840            * @param companyId the primary key of the structure's company
841            * @param classNameId the primary key of the class name for the structure's
842            related model
843            * @param orderByComparator the comparator to order the structures
844            (optionally <code>null</code>)
845            * @return the matching structures ordered by the comparator
846            * @throws SystemException if a system exception occurred
847            */
848            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
849                    long companyId, long classNameId,
850                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
851                    throws com.liferay.portal.kernel.exception.SystemException {
852                    return _ddmStructureLocalService.getClassStructures(companyId,
853                            classNameId, orderByComparator);
854            }
855    
856            /**
857            * @deprecated As of 6.2.0, replaced by {@link #getClassStructures(long,
858            long, OrderByComparator)}
859            */
860            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
861                    long classNameId,
862                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
863                    throws com.liferay.portal.kernel.exception.SystemException {
864                    return _ddmStructureLocalService.getClassStructures(classNameId,
865                            orderByComparator);
866            }
867    
868            /**
869            * Returns all the structures for the document library file entry type.
870            *
871            * @param dlFileEntryTypeId the primary key of the document library file
872            entry type
873            * @return the structures for the document library file entry type
874            * @throws SystemException if a system exception occurred
875            */
876            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeStructures(
877                    long dlFileEntryTypeId)
878                    throws com.liferay.portal.kernel.exception.SystemException {
879                    return _ddmStructureLocalService.getDLFileEntryTypeStructures(dlFileEntryTypeId);
880            }
881    
882            /**
883            * Returns the structure with the ID.
884            *
885            * @param structureId the primary key of the structure
886            * @return the structure with the ID
887            * @throws PortalException if a structure with the ID could not be found
888            * @throws SystemException if a system exception occurred
889            */
890            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure(
891                    long structureId)
892                    throws com.liferay.portal.kernel.exception.PortalException,
893                            com.liferay.portal.kernel.exception.SystemException {
894                    return _ddmStructureLocalService.getStructure(structureId);
895            }
896    
897            /**
898            * Returns the structure matching the class name ID, structure key, and
899            * group.
900            *
901            * @param groupId the primary key of the structure's group
902            * @param classNameId the primary key of the class name for the structure's
903            related model
904            * @param structureKey the unique string identifying the structure
905            * @return the matching structure
906            * @throws PortalException if a matching structure could not be found
907            * @throws SystemException if a system exception occurred
908            */
909            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure(
910                    long groupId, long classNameId, java.lang.String structureKey)
911                    throws com.liferay.portal.kernel.exception.PortalException,
912                            com.liferay.portal.kernel.exception.SystemException {
913                    return _ddmStructureLocalService.getStructure(groupId, classNameId,
914                            structureKey);
915            }
916    
917            /**
918            * Returns the structure matching the class name ID, structure key, and
919            * group, optionally in the global scope.
920            *
921            * <p>
922            * This method first searches in the group. If the structure is still not
923            * found and <code>includeGlobalStructures</code> is set to
924            * <code>true</code>, this method searches the global group.
925            * </p>
926            *
927            * @param groupId the primary key of the structure's group
928            * @param classNameId the primary key of the class name for the structure's
929            related model
930            * @param structureKey the unique string identifying the structure
931            * @param includeGlobalStructures whether to include the global scope in
932            the search
933            * @return the matching structure
934            * @throws PortalException if a matching structure could not be found
935            * @throws SystemException if a system exception occurred
936            */
937            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure(
938                    long groupId, long classNameId, java.lang.String structureKey,
939                    boolean includeGlobalStructures)
940                    throws com.liferay.portal.kernel.exception.PortalException,
941                            com.liferay.portal.kernel.exception.SystemException {
942                    return _ddmStructureLocalService.getStructure(groupId, classNameId,
943                            structureKey, includeGlobalStructures);
944            }
945    
946            /**
947            * Returns all the structures matching the group, name, and description.
948            *
949            * @param groupId the primary key of the structure's group
950            * @param name the structure's name
951            * @param description the structure's description
952            * @return the matching structures
953            * @throws SystemException if a system exception occurred
954            */
955            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructure(
956                    long groupId, java.lang.String name, java.lang.String description)
957                    throws com.liferay.portal.kernel.exception.SystemException {
958                    return _ddmStructureLocalService.getStructure(groupId, name, description);
959            }
960    
961            /**
962            * @deprecated As of 6.2.0, replaced by {@link #getStructures}
963            */
964            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries()
965                    throws com.liferay.portal.kernel.exception.SystemException {
966                    return _ddmStructureLocalService.getStructureEntries();
967            }
968    
969            /**
970            * @deprecated As of 6.2.0, replaced by {@link #getStructures(long)}
971            */
972            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries(
973                    long groupId)
974                    throws com.liferay.portal.kernel.exception.SystemException {
975                    return _ddmStructureLocalService.getStructureEntries(groupId);
976            }
977    
978            /**
979            * @deprecated As of 6.2.0, replaced by {@link #getStructures(long, int,
980            int)}
981            */
982            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries(
983                    long groupId, int start, int end)
984                    throws com.liferay.portal.kernel.exception.SystemException {
985                    return _ddmStructureLocalService.getStructureEntries(groupId, start, end);
986            }
987    
988            /**
989            * Returns all the structures present in the system.
990            *
991            * @return the structures present in the system
992            * @throws SystemException if a system exception occurred
993            */
994            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures()
995                    throws com.liferay.portal.kernel.exception.SystemException {
996                    return _ddmStructureLocalService.getStructures();
997            }
998    
999            /**
1000            * Returns all the structures present in the group.
1001            *
1002            * @param groupId the primary key of the group
1003            * @return the structures present in the group
1004            * @throws SystemException if a system exception occurred
1005            */
1006            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures(
1007                    long groupId)
1008                    throws com.liferay.portal.kernel.exception.SystemException {
1009                    return _ddmStructureLocalService.getStructures(groupId);
1010            }
1011    
1012            /**
1013            * Returns a range of all the structures belonging to the group.
1014            *
1015            * <p>
1016            * Useful when paginating results. Returns a maximum of <code>end -
1017            * start</code> instances. <code>start</code> and <code>end</code> are not
1018            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1019            * refers to the first result in the set. Setting both <code>start</code>
1020            * and <code>end</code> to {@link
1021            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1022            * result set.
1023            * </p>
1024            *
1025            * @param groupId the primary key of the group
1026            * @param start the lower bound of the range of structures to return
1027            * @param end the upper bound of the range of structures to return (not
1028            inclusive)
1029            * @return the range of matching structures, or <code>null</code> if no
1030            matches could be found
1031            * @throws SystemException if a system exception occurred
1032            */
1033            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures(
1034                    long groupId, int start, int end)
1035                    throws com.liferay.portal.kernel.exception.SystemException {
1036                    return _ddmStructureLocalService.getStructures(groupId, start, end);
1037            }
1038    
1039            /**
1040            * Returns all the structures matching class name ID and group.
1041            *
1042            * @param groupId the primary key of the group
1043            * @param classNameId the primary key of the class name for the structure's
1044            related model
1045            * @return the matching structures
1046            * @throws SystemException if a system exception occurred
1047            */
1048            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures(
1049                    long groupId, long classNameId)
1050                    throws com.liferay.portal.kernel.exception.SystemException {
1051                    return _ddmStructureLocalService.getStructures(groupId, classNameId);
1052            }
1053    
1054            /**
1055            * Returns a range of all the structures that match the class name ID and
1056            * group.
1057            *
1058            * <p>
1059            * Useful when paginating results. Returns a maximum of <code>end -
1060            * start</code> instances. <code>start</code> and <code>end</code> are not
1061            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1062            * refers to the first result in the set. Setting both <code>start</code>
1063            * and <code>end</code> to {@link
1064            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1065            * result set.
1066            * </p>
1067            *
1068            * @param groupId the primary key of the group
1069            * @param classNameId the primary key of the class name for the structure's
1070            related model
1071            * @param start the lower bound of the range of structures to return
1072            * @param end the upper bound of the range of structures to return (not
1073            inclusive)
1074            * @return the matching structures, or <code>null</code> if no matching
1075            structures could be found
1076            * @throws SystemException if a system exception occurred
1077            */
1078            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures(
1079                    long groupId, long classNameId, int start, int end)
1080                    throws com.liferay.portal.kernel.exception.SystemException {
1081                    return _ddmStructureLocalService.getStructures(groupId, classNameId,
1082                            start, end);
1083            }
1084    
1085            /**
1086            * Returns an ordered range of all the structures matching the class name ID
1087            * and group.
1088            *
1089            * <p>
1090            * Useful when paginating results. Returns a maximum of <code>end -
1091            * start</code> instances. <code>start</code> and <code>end</code> are not
1092            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1093            * refers to the first result in the set. Setting both <code>start</code>
1094            * and <code>end</code> to {@link
1095            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1096            * result set.
1097            * </p>
1098            *
1099            * @param groupId the primary key of the group
1100            * @param classNameId the primary key of the class name for the structure's
1101            related model
1102            * @param start the lower bound of the range of structures to return
1103            * @param end the upper bound of the range of structures to return (not
1104            inclusive)
1105            * @param orderByComparator the comparator to order the structures
1106            (optionally <code>null</code>)
1107            * @return the range of matching structures ordered by the comparator
1108            * @throws SystemException if a system exception occurred
1109            */
1110            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures(
1111                    long groupId, long classNameId, int start, int end,
1112                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
1113                    throws com.liferay.portal.kernel.exception.SystemException {
1114                    return _ddmStructureLocalService.getStructures(groupId, classNameId,
1115                            start, end, orderByComparator);
1116            }
1117    
1118            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures(
1119                    long groupId, java.lang.String name, java.lang.String description)
1120                    throws com.liferay.portal.kernel.exception.SystemException {
1121                    return _ddmStructureLocalService.getStructures(groupId, name,
1122                            description);
1123            }
1124    
1125            /**
1126            * Returns all the structures belonging to the groups.
1127            *
1128            * @param groupIds the primary keys of the groups
1129            * @return the structures belonging to the groups
1130            * @throws SystemException if a system exception occurred
1131            */
1132            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures(
1133                    long[] groupIds)
1134                    throws com.liferay.portal.kernel.exception.SystemException {
1135                    return _ddmStructureLocalService.getStructures(groupIds);
1136            }
1137    
1138            /**
1139            * Returns all the structures matching the class name ID and belonging to
1140            * the groups.
1141            *
1142            * @param groupIds the primary keys of the groups
1143            * @param classNameId the primary key of the class name for the structure's
1144            related model
1145            * @return the structures matching the class name ID and belonging to the
1146            groups
1147            * @throws SystemException if a system exception occurred
1148            */
1149            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures(
1150                    long[] groupIds, long classNameId)
1151                    throws com.liferay.portal.kernel.exception.SystemException {
1152                    return _ddmStructureLocalService.getStructures(groupIds, classNameId);
1153            }
1154    
1155            /**
1156            * Returns the number of structures belonging to the group.
1157            *
1158            * @param groupId the primary key of the group
1159            * @return the number of structures belonging to the group
1160            * @throws SystemException if a system exception occurred
1161            */
1162            public int getStructuresCount(long groupId)
1163                    throws com.liferay.portal.kernel.exception.SystemException {
1164                    return _ddmStructureLocalService.getStructuresCount(groupId);
1165            }
1166    
1167            /**
1168            * Returns the number of structures matching the class name ID and group.
1169            *
1170            * @param groupId the primary key of the group
1171            * @param classNameId the primary key of the class name for the structure's
1172            related model
1173            * @return the number of matching structures
1174            * @throws SystemException if a system exception occurred
1175            */
1176            public int getStructuresCount(long groupId, long classNameId)
1177                    throws com.liferay.portal.kernel.exception.SystemException {
1178                    return _ddmStructureLocalService.getStructuresCount(groupId, classNameId);
1179            }
1180    
1181            /**
1182            * Returns an ordered range of all the structures matching the groups and
1183            * class name IDs, and matching the keywords in the structure names and
1184            * descriptions.
1185            *
1186            * <p>
1187            * Useful when paginating results. Returns a maximum of <code>end -
1188            * start</code> instances. <code>start</code> and <code>end</code> are not
1189            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1190            * refers to the first result in the set. Setting both <code>start</code>
1191            * and <code>end</code> to {@link
1192            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1193            * result set.
1194            * </p>
1195            *
1196            * @param companyId the primary key of the structure's company
1197            * @param groupIds the primary keys of the groups
1198            * @param classNameIds the primary keys of the class names of the models
1199            the structures are related to
1200            * @param keywords the keywords (space separated), which may occur in the
1201            structure's name or description (optionally <code>null</code>)
1202            * @param start the lower bound of the range of structures to return
1203            * @param end the upper bound of the range of structures to return (not
1204            inclusive)
1205            * @param orderByComparator the comparator to order the structures
1206            (optionally <code>null</code>)
1207            * @return the range of matching structures ordered by the comparator
1208            * @throws SystemException if a system exception occurred
1209            */
1210            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> search(
1211                    long companyId, long[] groupIds, long[] classNameIds,
1212                    java.lang.String keywords, int start, int end,
1213                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
1214                    throws com.liferay.portal.kernel.exception.SystemException {
1215                    return _ddmStructureLocalService.search(companyId, groupIds,
1216                            classNameIds, keywords, start, end, orderByComparator);
1217            }
1218    
1219            /**
1220            * Returns an ordered range of all the structures matching the groups, class
1221            * name IDs, name keyword, description keyword, storage type, and type.
1222            *
1223            * <p>
1224            * Useful when paginating results. Returns a maximum of <code>end -
1225            * start</code> instances. <code>start</code> and <code>end</code> are not
1226            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1227            * refers to the first result in the set. Setting both <code>start</code>
1228            * and <code>end</code> to {@link
1229            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1230            * result set.
1231            * </p>
1232            *
1233            * @param companyId the primary key of the structure's company
1234            * @param groupIds the primary keys of the groups
1235            * @param classNameIds the primary keys of the class names of the models
1236            the structures are related to
1237            * @param name the name keywords
1238            * @param description the description keywords
1239            * @param storageType the structure's storage type. It can be "xml" or
1240            "expando". For more information, see {@link
1241            com.liferay.portlet.dynamicdatamapping.storage.StorageType}.
1242            * @param type the structure's type. For more information, see {@link
1243            com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}.
1244            * @param andOperator whether every field must match its keywords, or just
1245            one field
1246            * @param start the lower bound of the range of structures to return
1247            * @param end the upper bound of the range of structures to return (not
1248            inclusive)
1249            * @param orderByComparator the comparator to order the structures
1250            (optionally <code>null</code>)
1251            * @return the range of matching structures ordered by the comparator
1252            * @throws SystemException if a system exception occurred
1253            */
1254            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> search(
1255                    long companyId, long[] groupIds, long[] classNameIds,
1256                    java.lang.String name, java.lang.String description,
1257                    java.lang.String storageType, int type, boolean andOperator, int start,
1258                    int end,
1259                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
1260                    throws com.liferay.portal.kernel.exception.SystemException {
1261                    return _ddmStructureLocalService.search(companyId, groupIds,
1262                            classNameIds, name, description, storageType, type, andOperator,
1263                            start, end, orderByComparator);
1264            }
1265    
1266            /**
1267            * Returns the number of structures matching the groups and class name IDs,
1268            * and matching the keywords in the structure names and descriptions.
1269            *
1270            * @param companyId the primary key of the structure's company
1271            * @param groupIds the primary keys of the groups
1272            * @param classNameIds the primary keys of the class names of the models
1273            the structures are related to
1274            * @param keywords the keywords (space separated), which may occur in the
1275            structure's name or description (optionally <code>null</code>)
1276            * @return the number of matching structures
1277            * @throws SystemException if a system exception occurred
1278            */
1279            public int searchCount(long companyId, long[] groupIds,
1280                    long[] classNameIds, java.lang.String keywords)
1281                    throws com.liferay.portal.kernel.exception.SystemException {
1282                    return _ddmStructureLocalService.searchCount(companyId, groupIds,
1283                            classNameIds, keywords);
1284            }
1285    
1286            /**
1287            * Returns the number of structures matching the groups, class name IDs,
1288            * name keyword, description keyword, storage type, and type
1289            *
1290            * @param companyId the primary key of the structure's company
1291            * @param groupIds the primary keys of the groups
1292            * @param classNameIds the primary keys of the class names of the models
1293            the structure's are related to
1294            * @param name the name keywords
1295            * @param description the description keywords
1296            * @param storageType the structure's storage type. It can be "xml" or
1297            "expando". For more information, see {@link
1298            com.liferay.portlet.dynamicdatamapping.storage.StorageType}.
1299            * @param type the structure's type. For more information, see {@link
1300            com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}.
1301            * @param andOperator whether every field must match its keywords, or just
1302            one field
1303            * @return the number of matching structures
1304            * @throws SystemException if a system exception occurred
1305            */
1306            public int searchCount(long companyId, long[] groupIds,
1307                    long[] classNameIds, java.lang.String name,
1308                    java.lang.String description, java.lang.String storageType, int type,
1309                    boolean andOperator)
1310                    throws com.liferay.portal.kernel.exception.SystemException {
1311                    return _ddmStructureLocalService.searchCount(companyId, groupIds,
1312                            classNameIds, name, description, storageType, type, andOperator);
1313            }
1314    
1315            /**
1316            * Updates the structure matching the class name ID, structure key, and
1317            * group, replacing its old parent structure, name map, description map, and
1318            * XSD with new ones.
1319            *
1320            * @param groupId the primary key of the group
1321            * @param parentStructureId the primary key of the new parent structure
1322            * @param classNameId the primary key of the class name for the structure's
1323            related model
1324            * @param structureKey the unique string identifying the structure
1325            * @param nameMap the structure's new locales and localized names
1326            * @param descriptionMap the structure's new locales and localized
1327            description
1328            * @param xsd the structure's new XML schema definition
1329            * @param serviceContext the service context to be applied. Can set the
1330            structure's modification date.
1331            * @return the updated structure
1332            * @throws PortalException if a matching structure could not be found, if
1333            the XSD was not well-formed, or if a portal exception occurred
1334            * @throws SystemException if a system exception occurred
1335            */
1336            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure(
1337                    long groupId, long parentStructureId, long classNameId,
1338                    java.lang.String structureKey,
1339                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
1340                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
1341                    java.lang.String xsd,
1342                    com.liferay.portal.service.ServiceContext serviceContext)
1343                    throws com.liferay.portal.kernel.exception.PortalException,
1344                            com.liferay.portal.kernel.exception.SystemException {
1345                    return _ddmStructureLocalService.updateStructure(groupId,
1346                            parentStructureId, classNameId, structureKey, nameMap,
1347                            descriptionMap, xsd, serviceContext);
1348            }
1349    
1350            /**
1351            * Updates the structure matching the structure ID, replacing its old parent
1352            * structure, name map, description map, and XSD with new ones.
1353            *
1354            * @param structureId the primary key of the structure
1355            * @param parentStructureId the primary key of the new parent structure
1356            * @param nameMap the structure's new locales and localized names
1357            * @param descriptionMap the structure's new locales and localized
1358            descriptions
1359            * @param xsd the structure's new XML schema definition
1360            * @param serviceContext the service context to be applied. Can set the
1361            structure's modification date.
1362            * @return the updated structure
1363            * @throws PortalException if a matching structure could not be found, if
1364            the XSD was not well-formed, or if a portal exception occurred
1365            * @throws SystemException if a system exception occurred
1366            */
1367            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure(
1368                    long structureId, long parentStructureId,
1369                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
1370                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
1371                    java.lang.String xsd,
1372                    com.liferay.portal.service.ServiceContext serviceContext)
1373                    throws com.liferay.portal.kernel.exception.PortalException,
1374                            com.liferay.portal.kernel.exception.SystemException {
1375                    return _ddmStructureLocalService.updateStructure(structureId,
1376                            parentStructureId, nameMap, descriptionMap, xsd, serviceContext);
1377            }
1378    
1379            /**
1380            * Updates the structure matching the structure ID, replacing its XSD with a
1381            * new one.
1382            *
1383            * @param structureId the primary key of the structure
1384            * @param xsd the structure's new XML schema definition
1385            * @param serviceContext the service context to be applied. Can set the
1386            structure's modification date.
1387            * @return the updated structure
1388            * @throws PortalException if a matching structure could not be found, if
1389            the XSD was not well-formed, or if a portal exception occurred
1390            * @throws SystemException if a system exception occurred
1391            */
1392            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateXSD(
1393                    long structureId, java.lang.String xsd,
1394                    com.liferay.portal.service.ServiceContext serviceContext)
1395                    throws com.liferay.portal.kernel.exception.PortalException,
1396                            com.liferay.portal.kernel.exception.SystemException {
1397                    return _ddmStructureLocalService.updateXSD(structureId, xsd,
1398                            serviceContext);
1399            }
1400    
1401            /**
1402            * Updates the structure matching the structure ID, replacing the metadata
1403            * entry of the named field.
1404            *
1405            * @param structureId the primary key of the structure
1406            * @param fieldName the name of the field whose metadata to update
1407            * @param metadataEntryName the metadata entry's name
1408            * @param metadataEntryValue the metadata entry's value
1409            * @param serviceContext the service context to be applied. Can set the
1410            structure's modification date.
1411            * @throws PortalException if a matching structure could not be found, if
1412            the XSD was not well-formed, or if a portal exception occurred
1413            * @throws SystemException if a system exception occurred
1414            */
1415            public void updateXSDFieldMetadata(long structureId,
1416                    java.lang.String fieldName, java.lang.String metadataEntryName,
1417                    java.lang.String metadataEntryValue,
1418                    com.liferay.portal.service.ServiceContext serviceContext)
1419                    throws com.liferay.portal.kernel.exception.PortalException,
1420                            com.liferay.portal.kernel.exception.SystemException {
1421                    _ddmStructureLocalService.updateXSDFieldMetadata(structureId,
1422                            fieldName, metadataEntryName, metadataEntryValue, serviceContext);
1423            }
1424    
1425            /**
1426             * @deprecated As of 6.1.0, replaced by {@link #getWrappedService}
1427             */
1428            public DDMStructureLocalService getWrappedDDMStructureLocalService() {
1429                    return _ddmStructureLocalService;
1430            }
1431    
1432            /**
1433             * @deprecated As of 6.1.0, replaced by {@link #setWrappedService}
1434             */
1435            public void setWrappedDDMStructureLocalService(
1436                    DDMStructureLocalService ddmStructureLocalService) {
1437                    _ddmStructureLocalService = ddmStructureLocalService;
1438            }
1439    
1440            public DDMStructureLocalService getWrappedService() {
1441                    return _ddmStructureLocalService;
1442            }
1443    
1444            public void setWrappedService(
1445                    DDMStructureLocalService ddmStructureLocalService) {
1446                    _ddmStructureLocalService = ddmStructureLocalService;
1447            }
1448    
1449            private DDMStructureLocalService _ddmStructureLocalService;
1450    }