001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.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. 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.dynamicdatalists.model.impl.DDLRecordSetModelImpl}. 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.
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. 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.dynamicdatalists.model.impl.DDLRecordSetModelImpl}. 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.
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. 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.dynamicdatalists.model.impl.DDLRecordSetModelImpl}. 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.
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            * Returns the Spring bean ID for this bean.
255            *
256            * @return the Spring bean ID for this bean
257            */
258            public static java.lang.String getBeanIdentifier() {
259                    return getService().getBeanIdentifier();
260            }
261    
262            /**
263            * Sets the Spring bean ID for this bean.
264            *
265            * @param beanIdentifier the Spring bean ID for this bean
266            */
267            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
268                    getService().setBeanIdentifier(beanIdentifier);
269            }
270    
271            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet addRecordSet(
272                    long userId, long groupId, long ddmStructureId,
273                    java.lang.String recordSetKey,
274                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
275                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
276                    int minDisplayRows, int scope,
277                    com.liferay.portal.service.ServiceContext serviceContext)
278                    throws com.liferay.portal.kernel.exception.PortalException,
279                            com.liferay.portal.kernel.exception.SystemException {
280                    return getService()
281                                       .addRecordSet(userId, groupId, ddmStructureId, recordSetKey,
282                            nameMap, descriptionMap, minDisplayRows, scope, serviceContext);
283            }
284    
285            public static void addRecordSetResources(
286                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet recordSet,
287                    boolean addGroupPermissions, boolean addGuestPermissions)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException {
290                    getService()
291                            .addRecordSetResources(recordSet, addGroupPermissions,
292                            addGuestPermissions);
293            }
294    
295            public static void addRecordSetResources(
296                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet recordSet,
297                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
298                    throws com.liferay.portal.kernel.exception.PortalException,
299                            com.liferay.portal.kernel.exception.SystemException {
300                    getService()
301                            .addRecordSetResources(recordSet, groupPermissions, guestPermissions);
302            }
303    
304            public static void deleteRecordSet(
305                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet recordSet)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException {
308                    getService().deleteRecordSet(recordSet);
309            }
310    
311            public static void deleteRecordSet(long recordSetId)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    getService().deleteRecordSet(recordSetId);
315            }
316    
317            public static void deleteRecordSet(long groupId,
318                    java.lang.String recordSetKey)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException {
321                    getService().deleteRecordSet(groupId, recordSetKey);
322            }
323    
324            public static void deleteRecordSets(long groupId)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException {
327                    getService().deleteRecordSets(groupId);
328            }
329    
330            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet fetchRecordSet(
331                    long groupId, java.lang.String recordSetKey)
332                    throws com.liferay.portal.kernel.exception.SystemException {
333                    return getService().fetchRecordSet(groupId, recordSetKey);
334            }
335    
336            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet getRecordSet(
337                    long recordSetId)
338                    throws com.liferay.portal.kernel.exception.PortalException,
339                            com.liferay.portal.kernel.exception.SystemException {
340                    return getService().getRecordSet(recordSetId);
341            }
342    
343            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet getRecordSet(
344                    long groupId, java.lang.String recordSetKey)
345                    throws com.liferay.portal.kernel.exception.PortalException,
346                            com.liferay.portal.kernel.exception.SystemException {
347                    return getService().getRecordSet(groupId, recordSetKey);
348            }
349    
350            public static java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecordSet> getRecordSets(
351                    long groupId)
352                    throws com.liferay.portal.kernel.exception.SystemException {
353                    return getService().getRecordSets(groupId);
354            }
355    
356            public static int getRecordSetsCount(long groupId)
357                    throws com.liferay.portal.kernel.exception.SystemException {
358                    return getService().getRecordSetsCount(groupId);
359            }
360    
361            public static java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecordSet> search(
362                    long companyId, long groupId, java.lang.String keywords, int scope,
363                    int start, int end,
364                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
365                    throws com.liferay.portal.kernel.exception.SystemException {
366                    return getService()
367                                       .search(companyId, groupId, keywords, scope, start, end,
368                            orderByComparator);
369            }
370    
371            public static java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecordSet> search(
372                    long companyId, long groupId, java.lang.String name,
373                    java.lang.String description, int scope, boolean andOperator,
374                    int start, int end,
375                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
376                    throws com.liferay.portal.kernel.exception.SystemException {
377                    return getService()
378                                       .search(companyId, groupId, name, description, scope,
379                            andOperator, start, end, orderByComparator);
380            }
381    
382            public static int searchCount(long companyId, long groupId,
383                    java.lang.String keywords, int scope)
384                    throws com.liferay.portal.kernel.exception.SystemException {
385                    return getService().searchCount(companyId, groupId, keywords, scope);
386            }
387    
388            public static int searchCount(long companyId, long groupId,
389                    java.lang.String name, java.lang.String description, int scope,
390                    boolean andOperator)
391                    throws com.liferay.portal.kernel.exception.SystemException {
392                    return getService()
393                                       .searchCount(companyId, groupId, name, description, scope,
394                            andOperator);
395            }
396    
397            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateMinDisplayRows(
398                    long recordSetId, int minDisplayRows,
399                    com.liferay.portal.service.ServiceContext serviceContext)
400                    throws com.liferay.portal.kernel.exception.PortalException,
401                            com.liferay.portal.kernel.exception.SystemException {
402                    return getService()
403                                       .updateMinDisplayRows(recordSetId, minDisplayRows,
404                            serviceContext);
405            }
406    
407            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateRecordSet(
408                    long recordSetId, long ddmStructureId,
409                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
410                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
411                    int minDisplayRows,
412                    com.liferay.portal.service.ServiceContext serviceContext)
413                    throws com.liferay.portal.kernel.exception.PortalException,
414                            com.liferay.portal.kernel.exception.SystemException {
415                    return getService()
416                                       .updateRecordSet(recordSetId, ddmStructureId, nameMap,
417                            descriptionMap, minDisplayRows, serviceContext);
418            }
419    
420            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateRecordSet(
421                    long groupId, long ddmStructureId, java.lang.String recordSetKey,
422                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
423                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
424                    int minDisplayRows,
425                    com.liferay.portal.service.ServiceContext serviceContext)
426                    throws com.liferay.portal.kernel.exception.PortalException,
427                            com.liferay.portal.kernel.exception.SystemException {
428                    return getService()
429                                       .updateRecordSet(groupId, ddmStructureId, recordSetKey,
430                            nameMap, descriptionMap, minDisplayRows, serviceContext);
431            }
432    
433            public static DDLRecordSetLocalService getService() {
434                    if (_service == null) {
435                            _service = (DDLRecordSetLocalService)PortalBeanLocatorUtil.locate(DDLRecordSetLocalService.class.getName());
436    
437                            ReferenceRegistry.registerReference(DDLRecordSetLocalServiceUtil.class,
438                                    "_service");
439                    }
440    
441                    return _service;
442            }
443    
444            /**
445             * @deprecated
446             */
447            public void setService(DDLRecordSetLocalService service) {
448            }
449    
450            private static DDLRecordSetLocalService _service;
451    }