001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portlet.dynamicdatamapping.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the d d m 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                    com.liferay.portal.service.ServiceContext serviceContext)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException {
318                    return getService().copyStructure(userId, structureId, serviceContext);
319            }
320    
321            public static void deleteStructure(
322                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure)
323                    throws com.liferay.portal.kernel.exception.PortalException,
324                            com.liferay.portal.kernel.exception.SystemException {
325                    getService().deleteStructure(structure);
326            }
327    
328            public static void deleteStructure(long structureId)
329                    throws com.liferay.portal.kernel.exception.PortalException,
330                            com.liferay.portal.kernel.exception.SystemException {
331                    getService().deleteStructure(structureId);
332            }
333    
334            public static void deleteStructure(long groupId,
335                    java.lang.String structureKey)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException {
338                    getService().deleteStructure(groupId, structureKey);
339            }
340    
341            public static void deleteStructures(long groupId)
342                    throws com.liferay.portal.kernel.exception.PortalException,
343                            com.liferay.portal.kernel.exception.SystemException {
344                    getService().deleteStructures(groupId);
345            }
346    
347            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure(
348                    long structureId)
349                    throws com.liferay.portal.kernel.exception.SystemException {
350                    return getService().fetchStructure(structureId);
351            }
352    
353            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure(
354                    long groupId, java.lang.String structureKey)
355                    throws com.liferay.portal.kernel.exception.SystemException {
356                    return getService().fetchStructure(groupId, structureKey);
357            }
358    
359            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
360                    long classNameId)
361                    throws com.liferay.portal.kernel.exception.SystemException {
362                    return getService().getClassStructures(classNameId);
363            }
364    
365            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
366                    long classNameId, int start, int end)
367                    throws com.liferay.portal.kernel.exception.SystemException {
368                    return getService().getClassStructures(classNameId, start, end);
369            }
370    
371            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeStructures(
372                    long dlFileEntryTypeId)
373                    throws com.liferay.portal.kernel.exception.SystemException {
374                    return getService().getDLFileEntryTypeStructures(dlFileEntryTypeId);
375            }
376    
377            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure(
378                    long structureId)
379                    throws com.liferay.portal.kernel.exception.PortalException,
380                            com.liferay.portal.kernel.exception.SystemException {
381                    return getService().getStructure(structureId);
382            }
383    
384            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure(
385                    long groupId, java.lang.String structureKey)
386                    throws com.liferay.portal.kernel.exception.PortalException,
387                            com.liferay.portal.kernel.exception.SystemException {
388                    return getService().getStructure(groupId, structureKey);
389            }
390    
391            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructure(
392                    long groupId, java.lang.String name, java.lang.String description)
393                    throws com.liferay.portal.kernel.exception.SystemException {
394                    return getService().getStructure(groupId, name, description);
395            }
396    
397            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries()
398                    throws com.liferay.portal.kernel.exception.SystemException {
399                    return getService().getStructureEntries();
400            }
401    
402            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries(
403                    long groupId)
404                    throws com.liferay.portal.kernel.exception.SystemException {
405                    return getService().getStructureEntries(groupId);
406            }
407    
408            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries(
409                    long groupId, int start, int end)
410                    throws com.liferay.portal.kernel.exception.SystemException {
411                    return getService().getStructureEntries(groupId, start, end);
412            }
413    
414            public static int getStructureEntriesCount(long groupId)
415                    throws com.liferay.portal.kernel.exception.SystemException {
416                    return getService().getStructureEntriesCount(groupId);
417            }
418    
419            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> search(
420                    long companyId, long[] groupIds, long[] classNameIds,
421                    java.lang.String keywords, int start, int end,
422                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
423                    throws com.liferay.portal.kernel.exception.SystemException {
424                    return getService()
425                                       .search(companyId, groupIds, classNameIds, keywords, start,
426                            end, orderByComparator);
427            }
428    
429            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> search(
430                    long companyId, long[] groupIds, long[] classNameIds,
431                    java.lang.String name, java.lang.String description,
432                    java.lang.String storageType, int type, boolean andOperator, int start,
433                    int end,
434                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
435                    throws com.liferay.portal.kernel.exception.SystemException {
436                    return getService()
437                                       .search(companyId, groupIds, classNameIds, name,
438                            description, storageType, type, andOperator, start, end,
439                            orderByComparator);
440            }
441    
442            public static int searchCount(long companyId, long[] groupIds,
443                    long[] classNameIds, java.lang.String keywords)
444                    throws com.liferay.portal.kernel.exception.SystemException {
445                    return getService()
446                                       .searchCount(companyId, groupIds, classNameIds, keywords);
447            }
448    
449            public static int searchCount(long companyId, long[] groupIds,
450                    long[] classNameIds, java.lang.String name,
451                    java.lang.String description, java.lang.String storageType, int type,
452                    boolean andOperator)
453                    throws com.liferay.portal.kernel.exception.SystemException {
454                    return getService()
455                                       .searchCount(companyId, groupIds, classNameIds, name,
456                            description, storageType, type, andOperator);
457            }
458    
459            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure(
460                    long structureId,
461                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
462                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
463                    java.lang.String xsd,
464                    com.liferay.portal.service.ServiceContext serviceContext)
465                    throws com.liferay.portal.kernel.exception.PortalException,
466                            com.liferay.portal.kernel.exception.SystemException {
467                    return getService()
468                                       .updateStructure(structureId, nameMap, descriptionMap, xsd,
469                            serviceContext);
470            }
471    
472            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure(
473                    long groupId, java.lang.String structureKey,
474                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
475                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
476                    java.lang.String xsd,
477                    com.liferay.portal.service.ServiceContext serviceContext)
478                    throws com.liferay.portal.kernel.exception.PortalException,
479                            com.liferay.portal.kernel.exception.SystemException {
480                    return getService()
481                                       .updateStructure(groupId, structureKey, nameMap,
482                            descriptionMap, xsd, serviceContext);
483            }
484    
485            public static DDMStructureLocalService getService() {
486                    if (_service == null) {
487                            _service = (DDMStructureLocalService)PortalBeanLocatorUtil.locate(DDMStructureLocalService.class.getName());
488    
489                            ReferenceRegistry.registerReference(DDMStructureLocalServiceUtil.class,
490                                    "_service");
491                            MethodCache.remove(DDMStructureLocalService.class);
492                    }
493    
494                    return _service;
495            }
496    
497            public void setService(DDMStructureLocalService service) {
498                    MethodCache.remove(DDMStructureLocalService.class);
499    
500                    _service = service;
501    
502                    ReferenceRegistry.registerReference(DDMStructureLocalServiceUtil.class,
503                            "_service");
504                    MethodCache.remove(DDMStructureLocalService.class);
505            }
506    
507            private static DDMStructureLocalService _service;
508    }