001    /**
002     * Copyright (c) 2000-2012 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.ReferenceRegistry;
019    
020    /**
021     * 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.
022     *
023     * <p>
024     * 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.
025     * </p>
026     *
027     * @author Brian Wing Shun Chan
028     * @see DDMStructureLocalService
029     * @see com.liferay.portlet.dynamicdatamapping.service.base.DDMStructureLocalServiceBaseImpl
030     * @see com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLocalServiceImpl
031     * @generated
032     */
033    public class DDMStructureLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * 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.
038             */
039    
040            /**
041            * Adds the d d m structure to the database. Also notifies the appropriate model listeners.
042            *
043            * @param ddmStructure the d d m structure
044            * @return the d d m structure that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure addDDMStructure(
048                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addDDMStructure(ddmStructure);
051            }
052    
053            /**
054            * Creates a new d d m structure with the primary key. Does not add the d d m structure to the database.
055            *
056            * @param structureId the primary key for the new d d m structure
057            * @return the new d d m structure
058            */
059            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure createDDMStructure(
060                    long structureId) {
061                    return getService().createDDMStructure(structureId);
062            }
063    
064            /**
065            * Deletes the d d m structure with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param structureId the primary key of the d d m structure
068            * @return the d d m structure that was removed
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 com.liferay.portlet.dynamicdatamapping.model.DDMStructure deleteDDMStructure(
073                    long structureId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteDDMStructure(structureId);
077            }
078    
079            /**
080            * Deletes the d d m structure from the database. Also notifies the appropriate model listeners.
081            *
082            * @param ddmStructure the d d m structure
083            * @return the d d m structure that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure deleteDDMStructure(
087                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteDDMStructure(ddmStructure);
090            }
091    
092            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
093                    return getService().dynamicQuery();
094            }
095    
096            /**
097            * Performs a dynamic query on the database and returns the matching rows.
098            *
099            * @param dynamicQuery the dynamic query
100            * @return the matching rows
101            * @throws SystemException if a system exception occurred
102            */
103            @SuppressWarnings("rawtypes")
104            public static java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException {
107                    return getService().dynamicQuery(dynamicQuery);
108            }
109    
110            /**
111            * Performs a dynamic query on the database and returns a range of the matching rows.
112            *
113            * <p>
114            * 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.
115            * </p>
116            *
117            * @param dynamicQuery the dynamic query
118            * @param start the lower bound of the range of model instances
119            * @param end the upper bound of the range of model instances (not inclusive)
120            * @return the range of matching rows
121            * @throws SystemException if a system exception occurred
122            */
123            @SuppressWarnings("rawtypes")
124            public static java.util.List dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end) throws com.liferay.portal.kernel.exception.SystemException {
127                    return getService().dynamicQuery(dynamicQuery, start, end);
128            }
129    
130            /**
131            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
132            *
133            * <p>
134            * 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.
135            * </p>
136            *
137            * @param dynamicQuery the dynamic query
138            * @param start the lower bound of the range of model instances
139            * @param end the upper bound of the range of model instances (not inclusive)
140            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
141            * @return the ordered range of matching rows
142            * @throws SystemException if a system exception occurred
143            */
144            @SuppressWarnings("rawtypes")
145            public static java.util.List dynamicQuery(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
147                    int end,
148                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
149                    throws com.liferay.portal.kernel.exception.SystemException {
150                    return getService()
151                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
152            }
153    
154            /**
155            * Returns the number of rows that match the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @return the number of rows that match the dynamic query
159            * @throws SystemException if a system exception occurred
160            */
161            public static long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().dynamicQueryCount(dynamicQuery);
165            }
166    
167            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchDDMStructure(
168                    long structureId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchDDMStructure(structureId);
171            }
172    
173            /**
174            * Returns the d d m structure with the primary key.
175            *
176            * @param structureId the primary key of the d d m structure
177            * @return the d d m structure
178            * @throws PortalException if a d d m structure with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure getDDMStructure(
182                    long structureId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getDDMStructure(structureId);
186            }
187    
188            public static com.liferay.portal.model.PersistedModel getPersistedModel(
189                    java.io.Serializable primaryKeyObj)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException {
192                    return getService().getPersistedModel(primaryKeyObj);
193            }
194    
195            /**
196            * Returns the d d m structure with the UUID in the group.
197            *
198            * @param uuid the UUID of d d m structure
199            * @param groupId the group id of the d d m structure
200            * @return the d d m structure
201            * @throws PortalException if a d d m structure with the UUID in the group could not be found
202            * @throws SystemException if a system exception occurred
203            */
204            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure getDDMStructureByUuidAndGroupId(
205                    java.lang.String uuid, long groupId)
206                    throws com.liferay.portal.kernel.exception.PortalException,
207                            com.liferay.portal.kernel.exception.SystemException {
208                    return getService().getDDMStructureByUuidAndGroupId(uuid, groupId);
209            }
210    
211            /**
212            * Returns a range of all the d d m structures.
213            *
214            * <p>
215            * 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.
216            * </p>
217            *
218            * @param start the lower bound of the range of d d m structures
219            * @param end the upper bound of the range of d d m structures (not inclusive)
220            * @return the range of d d m structures
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDDMStructures(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getDDMStructures(start, end);
227            }
228    
229            /**
230            * Returns the number of d d m structures.
231            *
232            * @return the number of d d m structures
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getDDMStructuresCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getDDMStructuresCount();
238            }
239    
240            /**
241            * Updates the d d m structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param ddmStructure the d d m structure
244            * @return the d d m structure that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateDDMStructure(
248                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateDDMStructure(ddmStructure);
251            }
252    
253            /**
254            * Updates the d d m structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
255            *
256            * @param ddmStructure the d d m structure
257            * @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.
258            * @return the d d m structure that was updated
259            * @throws SystemException if a system exception occurred
260            */
261            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateDDMStructure(
262                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure,
263                    boolean merge)
264                    throws com.liferay.portal.kernel.exception.SystemException {
265                    return getService().updateDDMStructure(ddmStructure, merge);
266            }
267    
268            /**
269            * Returns the Spring bean ID for this bean.
270            *
271            * @return the Spring bean ID for this bean
272            */
273            public static java.lang.String getBeanIdentifier() {
274                    return getService().getBeanIdentifier();
275            }
276    
277            /**
278            * Sets the Spring bean ID for this bean.
279            *
280            * @param beanIdentifier the Spring bean ID for this bean
281            */
282            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
283                    getService().setBeanIdentifier(beanIdentifier);
284            }
285    
286            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure addStructure(
287                    long userId, long groupId, long classNameId,
288                    java.lang.String structureKey,
289                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
290                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
291                    java.lang.String xsd, java.lang.String storageType, int type,
292                    com.liferay.portal.service.ServiceContext serviceContext)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException {
295                    return getService()
296                                       .addStructure(userId, groupId, classNameId, structureKey,
297                            nameMap, descriptionMap, xsd, storageType, type, serviceContext);
298            }
299    
300            public static void addStructureResources(
301                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure,
302                    boolean addGroupPermissions, boolean addGuestPermissions)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    getService()
306                            .addStructureResources(structure, addGroupPermissions,
307                            addGuestPermissions);
308            }
309    
310            public static void addStructureResources(
311                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure,
312                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException {
315                    getService()
316                            .addStructureResources(structure, groupPermissions, guestPermissions);
317            }
318    
319            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure copyStructure(
320                    long userId, long structureId,
321                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
322                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
323                    com.liferay.portal.service.ServiceContext serviceContext)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException {
326                    return getService()
327                                       .copyStructure(userId, structureId, nameMap, descriptionMap,
328                            serviceContext);
329            }
330    
331            public static void deleteStructure(
332                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException {
335                    getService().deleteStructure(structure);
336            }
337    
338            public static void deleteStructure(long structureId)
339                    throws com.liferay.portal.kernel.exception.PortalException,
340                            com.liferay.portal.kernel.exception.SystemException {
341                    getService().deleteStructure(structureId);
342            }
343    
344            public static void deleteStructure(long groupId,
345                    java.lang.String structureKey)
346                    throws com.liferay.portal.kernel.exception.PortalException,
347                            com.liferay.portal.kernel.exception.SystemException {
348                    getService().deleteStructure(groupId, structureKey);
349            }
350    
351            public static void deleteStructures(long groupId)
352                    throws com.liferay.portal.kernel.exception.PortalException,
353                            com.liferay.portal.kernel.exception.SystemException {
354                    getService().deleteStructures(groupId);
355            }
356    
357            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure(
358                    long structureId)
359                    throws com.liferay.portal.kernel.exception.SystemException {
360                    return getService().fetchStructure(structureId);
361            }
362    
363            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure(
364                    long groupId, java.lang.String structureKey)
365                    throws com.liferay.portal.kernel.exception.SystemException {
366                    return getService().fetchStructure(groupId, structureKey);
367            }
368    
369            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
370                    long classNameId)
371                    throws com.liferay.portal.kernel.exception.SystemException {
372                    return getService().getClassStructures(classNameId);
373            }
374    
375            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
376                    long classNameId, int start, int end)
377                    throws com.liferay.portal.kernel.exception.SystemException {
378                    return getService().getClassStructures(classNameId, start, end);
379            }
380    
381            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
382                    long classNameId,
383                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
384                    throws com.liferay.portal.kernel.exception.SystemException {
385                    return getService().getClassStructures(classNameId, orderByComparator);
386            }
387    
388            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeStructures(
389                    long dlFileEntryTypeId)
390                    throws com.liferay.portal.kernel.exception.SystemException {
391                    return getService().getDLFileEntryTypeStructures(dlFileEntryTypeId);
392            }
393    
394            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure(
395                    long structureId)
396                    throws com.liferay.portal.kernel.exception.PortalException,
397                            com.liferay.portal.kernel.exception.SystemException {
398                    return getService().getStructure(structureId);
399            }
400    
401            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure(
402                    long groupId, java.lang.String structureKey)
403                    throws com.liferay.portal.kernel.exception.PortalException,
404                            com.liferay.portal.kernel.exception.SystemException {
405                    return getService().getStructure(groupId, structureKey);
406            }
407    
408            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructure(
409                    long groupId, java.lang.String name, java.lang.String description)
410                    throws com.liferay.portal.kernel.exception.SystemException {
411                    return getService().getStructure(groupId, name, description);
412            }
413    
414            /**
415            * @deprecated {@link #getStructures}
416            */
417            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries()
418                    throws com.liferay.portal.kernel.exception.SystemException {
419                    return getService().getStructureEntries();
420            }
421    
422            /**
423            * @deprecated {@link #getStructures(long)}
424            */
425            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries(
426                    long groupId)
427                    throws com.liferay.portal.kernel.exception.SystemException {
428                    return getService().getStructureEntries(groupId);
429            }
430    
431            /**
432            * @deprecated {@link #getStructures(long, int, int)}
433            */
434            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries(
435                    long groupId, int start, int end)
436                    throws com.liferay.portal.kernel.exception.SystemException {
437                    return getService().getStructureEntries(groupId, start, end);
438            }
439    
440            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures()
441                    throws com.liferay.portal.kernel.exception.SystemException {
442                    return getService().getStructures();
443            }
444    
445            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures(
446                    long groupId)
447                    throws com.liferay.portal.kernel.exception.SystemException {
448                    return getService().getStructures(groupId);
449            }
450    
451            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures(
452                    long groupId, int start, int end)
453                    throws com.liferay.portal.kernel.exception.SystemException {
454                    return getService().getStructures(groupId, start, end);
455            }
456    
457            public static int getStructuresCount(long groupId)
458                    throws com.liferay.portal.kernel.exception.SystemException {
459                    return getService().getStructuresCount(groupId);
460            }
461    
462            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> search(
463                    long companyId, long[] groupIds, long[] classNameIds,
464                    java.lang.String keywords, int start, int end,
465                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
466                    throws com.liferay.portal.kernel.exception.SystemException {
467                    return getService()
468                                       .search(companyId, groupIds, classNameIds, keywords, start,
469                            end, orderByComparator);
470            }
471    
472            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> search(
473                    long companyId, long[] groupIds, long[] classNameIds,
474                    java.lang.String name, java.lang.String description,
475                    java.lang.String storageType, int type, boolean andOperator, int start,
476                    int end,
477                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
478                    throws com.liferay.portal.kernel.exception.SystemException {
479                    return getService()
480                                       .search(companyId, groupIds, classNameIds, name,
481                            description, storageType, type, andOperator, start, end,
482                            orderByComparator);
483            }
484    
485            public static int searchCount(long companyId, long[] groupIds,
486                    long[] classNameIds, java.lang.String keywords)
487                    throws com.liferay.portal.kernel.exception.SystemException {
488                    return getService()
489                                       .searchCount(companyId, groupIds, classNameIds, keywords);
490            }
491    
492            public static int searchCount(long companyId, long[] groupIds,
493                    long[] classNameIds, java.lang.String name,
494                    java.lang.String description, java.lang.String storageType, int type,
495                    boolean andOperator)
496                    throws com.liferay.portal.kernel.exception.SystemException {
497                    return getService()
498                                       .searchCount(companyId, groupIds, classNameIds, name,
499                            description, storageType, type, andOperator);
500            }
501    
502            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure(
503                    long structureId,
504                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
505                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
506                    java.lang.String xsd,
507                    com.liferay.portal.service.ServiceContext serviceContext)
508                    throws com.liferay.portal.kernel.exception.PortalException,
509                            com.liferay.portal.kernel.exception.SystemException {
510                    return getService()
511                                       .updateStructure(structureId, nameMap, descriptionMap, xsd,
512                            serviceContext);
513            }
514    
515            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure(
516                    long groupId, java.lang.String structureKey,
517                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
518                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
519                    java.lang.String xsd,
520                    com.liferay.portal.service.ServiceContext serviceContext)
521                    throws com.liferay.portal.kernel.exception.PortalException,
522                            com.liferay.portal.kernel.exception.SystemException {
523                    return getService()
524                                       .updateStructure(groupId, structureKey, nameMap,
525                            descriptionMap, xsd, serviceContext);
526            }
527    
528            public static DDMStructureLocalService getService() {
529                    if (_service == null) {
530                            _service = (DDMStructureLocalService)PortalBeanLocatorUtil.locate(DDMStructureLocalService.class.getName());
531    
532                            ReferenceRegistry.registerReference(DDMStructureLocalServiceUtil.class,
533                                    "_service");
534                    }
535    
536                    return _service;
537            }
538    
539            /**
540             * @deprecated
541             */
542            public void setService(DDMStructureLocalService service) {
543            }
544    
545            private static DDMStructureLocalService _service;
546    }