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.dynamicdatalists.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 l record set local service. This utility wraps {@link com.liferay.portlet.dynamicdatalists.service.impl.DDLRecordSetLocalServiceImpl} 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 DDLRecordSetLocalService
029     * @see com.liferay.portlet.dynamicdatalists.service.base.DDLRecordSetLocalServiceBaseImpl
030     * @see com.liferay.portlet.dynamicdatalists.service.impl.DDLRecordSetLocalServiceImpl
031     * @generated
032     */
033    public class DDLRecordSetLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.dynamicdatalists.service.impl.DDLRecordSetLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the d d l record set to the database. Also notifies the appropriate model listeners.
042            *
043            * @param ddlRecordSet the d d l record set
044            * @return the d d l record set that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet addDDLRecordSet(
048                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet ddlRecordSet)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addDDLRecordSet(ddlRecordSet);
051            }
052    
053            /**
054            * Creates a new d d l record set with the primary key. Does not add the d d l record set to the database.
055            *
056            * @param recordSetId the primary key for the new d d l record set
057            * @return the new d d l record set
058            */
059            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet createDDLRecordSet(
060                    long recordSetId) {
061                    return getService().createDDLRecordSet(recordSetId);
062            }
063    
064            /**
065            * Deletes the d d l record set with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param recordSetId the primary key of the d d l record set
068            * @return the d d l record set that was removed
069            * @throws PortalException if a d d l record set with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet deleteDDLRecordSet(
073                    long recordSetId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteDDLRecordSet(recordSetId);
077            }
078    
079            /**
080            * Deletes the d d l record set from the database. Also notifies the appropriate model listeners.
081            *
082            * @param ddlRecordSet the d d l record set
083            * @return the d d l record set that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet deleteDDLRecordSet(
087                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet ddlRecordSet)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteDDLRecordSet(ddlRecordSet);
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.dynamicdatalists.model.DDLRecordSet fetchDDLRecordSet(
168                    long recordSetId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchDDLRecordSet(recordSetId);
171            }
172    
173            /**
174            * Returns the d d l record set with the primary key.
175            *
176            * @param recordSetId the primary key of the d d l record set
177            * @return the d d l record set
178            * @throws PortalException if a d d l record set with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet getDDLRecordSet(
182                    long recordSetId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getDDLRecordSet(recordSetId);
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 l record set with the UUID in the group.
197            *
198            * @param uuid the UUID of d d l record set
199            * @param groupId the group id of the d d l record set
200            * @return the d d l record set
201            * @throws PortalException if a d d l record set 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.dynamicdatalists.model.DDLRecordSet getDDLRecordSetByUuidAndGroupId(
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().getDDLRecordSetByUuidAndGroupId(uuid, groupId);
209            }
210    
211            /**
212            * Returns a range of all the d d l record sets.
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 l record sets
219            * @param end the upper bound of the range of d d l record sets (not inclusive)
220            * @return the range of d d l record sets
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecordSet> getDDLRecordSets(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getDDLRecordSets(start, end);
227            }
228    
229            /**
230            * Returns the number of d d l record sets.
231            *
232            * @return the number of d d l record sets
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getDDLRecordSetsCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getDDLRecordSetsCount();
238            }
239    
240            /**
241            * Updates the d d l record set in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param ddlRecordSet the d d l record set
244            * @return the d d l record set that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateDDLRecordSet(
248                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet ddlRecordSet)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateDDLRecordSet(ddlRecordSet);
251            }
252    
253            /**
254            * Updates the d d l record set in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
255            *
256            * @param ddlRecordSet the d d l record set
257            * @param merge whether to merge the d d l record set 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 l record set that was updated
259            * @throws SystemException if a system exception occurred
260            */
261            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateDDLRecordSet(
262                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet ddlRecordSet,
263                    boolean merge)
264                    throws com.liferay.portal.kernel.exception.SystemException {
265                    return getService().updateDDLRecordSet(ddlRecordSet, 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.dynamicdatalists.model.DDLRecordSet addRecordSet(
287                    long userId, long groupId, long ddmStructureId,
288                    java.lang.String recordSetKey,
289                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
290                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
291                    int minDisplayRows, int scope,
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                                       .addRecordSet(userId, groupId, ddmStructureId, recordSetKey,
297                            nameMap, descriptionMap, minDisplayRows, scope, serviceContext);
298            }
299    
300            public static void addRecordSetResources(
301                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet recordSet,
302                    boolean addGroupPermissions, boolean addGuestPermissions)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    getService()
306                            .addRecordSetResources(recordSet, addGroupPermissions,
307                            addGuestPermissions);
308            }
309    
310            public static void addRecordSetResources(
311                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet recordSet,
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                            .addRecordSetResources(recordSet, groupPermissions, guestPermissions);
317            }
318    
319            public static void deleteRecordSet(
320                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet recordSet)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException {
323                    getService().deleteRecordSet(recordSet);
324            }
325    
326            public static void deleteRecordSet(long recordSetId)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException {
329                    getService().deleteRecordSet(recordSetId);
330            }
331    
332            public static void deleteRecordSet(long groupId,
333                    java.lang.String recordSetKey)
334                    throws com.liferay.portal.kernel.exception.PortalException,
335                            com.liferay.portal.kernel.exception.SystemException {
336                    getService().deleteRecordSet(groupId, recordSetKey);
337            }
338    
339            public static void deleteRecordSets(long groupId)
340                    throws com.liferay.portal.kernel.exception.PortalException,
341                            com.liferay.portal.kernel.exception.SystemException {
342                    getService().deleteRecordSets(groupId);
343            }
344    
345            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet fetchRecordSet(
346                    long groupId, java.lang.String recordSetKey)
347                    throws com.liferay.portal.kernel.exception.SystemException {
348                    return getService().fetchRecordSet(groupId, recordSetKey);
349            }
350    
351            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet getRecordSet(
352                    long recordSetId)
353                    throws com.liferay.portal.kernel.exception.PortalException,
354                            com.liferay.portal.kernel.exception.SystemException {
355                    return getService().getRecordSet(recordSetId);
356            }
357    
358            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet getRecordSet(
359                    long groupId, java.lang.String recordSetKey)
360                    throws com.liferay.portal.kernel.exception.PortalException,
361                            com.liferay.portal.kernel.exception.SystemException {
362                    return getService().getRecordSet(groupId, recordSetKey);
363            }
364    
365            public static java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecordSet> getRecordSets(
366                    long groupId)
367                    throws com.liferay.portal.kernel.exception.SystemException {
368                    return getService().getRecordSets(groupId);
369            }
370    
371            public static int getRecordSetsCount(long groupId)
372                    throws com.liferay.portal.kernel.exception.SystemException {
373                    return getService().getRecordSetsCount(groupId);
374            }
375    
376            public static java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecordSet> search(
377                    long companyId, long groupId, java.lang.String keywords, int scope,
378                    int start, int end,
379                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
380                    throws com.liferay.portal.kernel.exception.SystemException {
381                    return getService()
382                                       .search(companyId, groupId, keywords, scope, start, end,
383                            orderByComparator);
384            }
385    
386            public static java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecordSet> search(
387                    long companyId, long groupId, java.lang.String name,
388                    java.lang.String description, int scope, boolean andOperator,
389                    int start, int end,
390                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
391                    throws com.liferay.portal.kernel.exception.SystemException {
392                    return getService()
393                                       .search(companyId, groupId, name, description, scope,
394                            andOperator, start, end, orderByComparator);
395            }
396    
397            public static int searchCount(long companyId, long groupId,
398                    java.lang.String keywords, int scope)
399                    throws com.liferay.portal.kernel.exception.SystemException {
400                    return getService().searchCount(companyId, groupId, keywords, scope);
401            }
402    
403            public static int searchCount(long companyId, long groupId,
404                    java.lang.String name, java.lang.String description, int scope,
405                    boolean andOperator)
406                    throws com.liferay.portal.kernel.exception.SystemException {
407                    return getService()
408                                       .searchCount(companyId, groupId, name, description, scope,
409                            andOperator);
410            }
411    
412            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateMinDisplayRows(
413                    long recordSetId, int minDisplayRows,
414                    com.liferay.portal.service.ServiceContext serviceContext)
415                    throws com.liferay.portal.kernel.exception.PortalException,
416                            com.liferay.portal.kernel.exception.SystemException {
417                    return getService()
418                                       .updateMinDisplayRows(recordSetId, minDisplayRows,
419                            serviceContext);
420            }
421    
422            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateRecordSet(
423                    long recordSetId, long ddmStructureId,
424                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
425                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
426                    int minDisplayRows,
427                    com.liferay.portal.service.ServiceContext serviceContext)
428                    throws com.liferay.portal.kernel.exception.PortalException,
429                            com.liferay.portal.kernel.exception.SystemException {
430                    return getService()
431                                       .updateRecordSet(recordSetId, ddmStructureId, nameMap,
432                            descriptionMap, minDisplayRows, serviceContext);
433            }
434    
435            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateRecordSet(
436                    long groupId, long ddmStructureId, java.lang.String recordSetKey,
437                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
438                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
439                    int minDisplayRows,
440                    com.liferay.portal.service.ServiceContext serviceContext)
441                    throws com.liferay.portal.kernel.exception.PortalException,
442                            com.liferay.portal.kernel.exception.SystemException {
443                    return getService()
444                                       .updateRecordSet(groupId, ddmStructureId, recordSetKey,
445                            nameMap, descriptionMap, minDisplayRows, serviceContext);
446            }
447    
448            public static DDLRecordSetLocalService getService() {
449                    if (_service == null) {
450                            _service = (DDLRecordSetLocalService)PortalBeanLocatorUtil.locate(DDLRecordSetLocalService.class.getName());
451    
452                            ReferenceRegistry.registerReference(DDLRecordSetLocalServiceUtil.class,
453                                    "_service");
454                    }
455    
456                    return _service;
457            }
458    
459            /**
460             * @deprecated
461             */
462            public void setService(DDLRecordSetLocalService service) {
463            }
464    
465            private static DDLRecordSetLocalService _service;
466    }