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 local service. This utility wraps {@link com.liferay.portlet.dynamicdatalists.service.impl.DDLRecordLocalServiceImpl} 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 DDLRecordLocalService
029     * @see com.liferay.portlet.dynamicdatalists.service.base.DDLRecordLocalServiceBaseImpl
030     * @see com.liferay.portlet.dynamicdatalists.service.impl.DDLRecordLocalServiceImpl
031     * @generated
032     */
033    public class DDLRecordLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.dynamicdatalists.service.impl.DDLRecordLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the d d l record to the database. Also notifies the appropriate model listeners.
042            *
043            * @param ddlRecord the d d l record
044            * @return the d d l record that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.dynamicdatalists.model.DDLRecord addDDLRecord(
048                    com.liferay.portlet.dynamicdatalists.model.DDLRecord ddlRecord)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addDDLRecord(ddlRecord);
051            }
052    
053            /**
054            * Creates a new d d l record with the primary key. Does not add the d d l record to the database.
055            *
056            * @param recordId the primary key for the new d d l record
057            * @return the new d d l record
058            */
059            public static com.liferay.portlet.dynamicdatalists.model.DDLRecord createDDLRecord(
060                    long recordId) {
061                    return getService().createDDLRecord(recordId);
062            }
063    
064            /**
065            * Deletes the d d l record with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param recordId the primary key of the d d l record
068            * @return the d d l record that was removed
069            * @throws PortalException if a d d l record 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.DDLRecord deleteDDLRecord(
073                    long recordId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteDDLRecord(recordId);
077            }
078    
079            /**
080            * Deletes the d d l record from the database. Also notifies the appropriate model listeners.
081            *
082            * @param ddlRecord the d d l record
083            * @return the d d l record that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.dynamicdatalists.model.DDLRecord deleteDDLRecord(
087                    com.liferay.portlet.dynamicdatalists.model.DDLRecord ddlRecord)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteDDLRecord(ddlRecord);
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.DDLRecord fetchDDLRecord(
168                    long recordId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchDDLRecord(recordId);
171            }
172    
173            /**
174            * Returns the d d l record with the primary key.
175            *
176            * @param recordId the primary key of the d d l record
177            * @return the d d l record
178            * @throws PortalException if a d d l record 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.DDLRecord getDDLRecord(
182                    long recordId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getDDLRecord(recordId);
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 with the UUID in the group.
197            *
198            * @param uuid the UUID of d d l record
199            * @param groupId the group id of the d d l record
200            * @return the d d l record
201            * @throws PortalException if a d d l record 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.DDLRecord getDDLRecordByUuidAndGroupId(
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().getDDLRecordByUuidAndGroupId(uuid, groupId);
209            }
210    
211            /**
212            * Returns a range of all the d d l records.
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 records
219            * @param end the upper bound of the range of d d l records (not inclusive)
220            * @return the range of d d l records
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecord> getDDLRecords(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getDDLRecords(start, end);
227            }
228    
229            /**
230            * Returns the number of d d l records.
231            *
232            * @return the number of d d l records
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getDDLRecordsCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getDDLRecordsCount();
238            }
239    
240            /**
241            * Updates the d d l record in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param ddlRecord the d d l record
244            * @return the d d l record that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portlet.dynamicdatalists.model.DDLRecord updateDDLRecord(
248                    com.liferay.portlet.dynamicdatalists.model.DDLRecord ddlRecord)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateDDLRecord(ddlRecord);
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.DDLRecord addRecord(
272                    long userId, long groupId, long recordSetId, int displayIndex,
273                    com.liferay.portlet.dynamicdatamapping.storage.Fields fields,
274                    com.liferay.portal.service.ServiceContext serviceContext)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException {
277                    return getService()
278                                       .addRecord(userId, groupId, recordSetId, displayIndex,
279                            fields, serviceContext);
280            }
281    
282            public static com.liferay.portlet.dynamicdatalists.model.DDLRecord addRecord(
283                    long userId, long groupId, long recordSetId, int displayIndex,
284                    java.util.Map<java.lang.String, java.io.Serializable> fieldsMap,
285                    com.liferay.portal.service.ServiceContext serviceContext)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException {
288                    return getService()
289                                       .addRecord(userId, groupId, recordSetId, displayIndex,
290                            fieldsMap, serviceContext);
291            }
292    
293            public static void deleteRecord(
294                    com.liferay.portlet.dynamicdatalists.model.DDLRecord record)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    getService().deleteRecord(record);
298            }
299    
300            public static void deleteRecord(long recordId)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException {
303                    getService().deleteRecord(recordId);
304            }
305    
306            public static void deleteRecords(long recordSetId)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException {
309                    getService().deleteRecords(recordSetId);
310            }
311    
312            public static com.liferay.portlet.dynamicdatalists.model.DDLRecord fetchRecord(
313                    long recordId)
314                    throws com.liferay.portal.kernel.exception.SystemException {
315                    return getService().fetchRecord(recordId);
316            }
317    
318            public static java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecord> getCompanyRecords(
319                    long companyId, int status, int scope, int start, int end,
320                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
321                    throws com.liferay.portal.kernel.exception.SystemException {
322                    return getService()
323                                       .getCompanyRecords(companyId, status, scope, start, end,
324                            orderByComparator);
325            }
326    
327            /**
328            * @deprecated {@link #getCompanyRecords(long, int, int, int, int,
329            OrderByComparator)}
330            */
331            public static java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecord> getCompanyRecords(
332                    long companyId, int scope, int start, int end,
333                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
334                    throws com.liferay.portal.kernel.exception.SystemException {
335                    return getService()
336                                       .getCompanyRecords(companyId, scope, start, end,
337                            orderByComparator);
338            }
339    
340            /**
341            * @deprecated {@link #getCompanyRecordsCount(long, int, int)}
342            */
343            public static int getCompanyRecordsCount(long companyId, int scope)
344                    throws com.liferay.portal.kernel.exception.SystemException {
345                    return getService().getCompanyRecordsCount(companyId, scope);
346            }
347    
348            public static int getCompanyRecordsCount(long companyId, int status,
349                    int scope) throws com.liferay.portal.kernel.exception.SystemException {
350                    return getService().getCompanyRecordsCount(companyId, status, scope);
351            }
352    
353            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordVersion getLatestRecordVersion(
354                    long recordId)
355                    throws com.liferay.portal.kernel.exception.PortalException,
356                            com.liferay.portal.kernel.exception.SystemException {
357                    return getService().getLatestRecordVersion(recordId);
358            }
359    
360            public static java.lang.Long[] getMinAndMaxCompanyRecordIds(
361                    long companyId, int status, int scope)
362                    throws com.liferay.portal.kernel.exception.SystemException {
363                    return getService()
364                                       .getMinAndMaxCompanyRecordIds(companyId, status, scope);
365            }
366    
367            public static java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecord> getMinAndMaxCompanyRecords(
368                    long companyId, int status, int scope, long minRecordId,
369                    long maxRecordId)
370                    throws com.liferay.portal.kernel.exception.SystemException {
371                    return getService()
372                                       .getMinAndMaxCompanyRecords(companyId, status, scope,
373                            minRecordId, maxRecordId);
374            }
375    
376            public static com.liferay.portlet.dynamicdatalists.model.DDLRecord getRecord(
377                    long recordId)
378                    throws com.liferay.portal.kernel.exception.PortalException,
379                            com.liferay.portal.kernel.exception.SystemException {
380                    return getService().getRecord(recordId);
381            }
382    
383            public static java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecord> getRecords(
384                    long recordSetId)
385                    throws com.liferay.portal.kernel.exception.SystemException {
386                    return getService().getRecords(recordSetId);
387            }
388    
389            public static java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecord> getRecords(
390                    long recordSetId, int status, int start, int end,
391                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
392                    throws com.liferay.portal.kernel.exception.SystemException {
393                    return getService()
394                                       .getRecords(recordSetId, status, start, end,
395                            orderByComparator);
396            }
397    
398            public static java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecord> getRecords(
399                    long recordSetId, long userId)
400                    throws com.liferay.portal.kernel.exception.SystemException {
401                    return getService().getRecords(recordSetId, userId);
402            }
403    
404            public static int getRecordsCount(long recordSetId, int status)
405                    throws com.liferay.portal.kernel.exception.SystemException {
406                    return getService().getRecordsCount(recordSetId, status);
407            }
408    
409            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordVersion getRecordVersion(
410                    long recordVersionId)
411                    throws com.liferay.portal.kernel.exception.PortalException,
412                            com.liferay.portal.kernel.exception.SystemException {
413                    return getService().getRecordVersion(recordVersionId);
414            }
415    
416            public static com.liferay.portlet.dynamicdatalists.model.DDLRecordVersion getRecordVersion(
417                    long recordId, java.lang.String version)
418                    throws com.liferay.portal.kernel.exception.PortalException,
419                            com.liferay.portal.kernel.exception.SystemException {
420                    return getService().getRecordVersion(recordId, version);
421            }
422    
423            public static java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecordVersion> getRecordVersions(
424                    long recordId, int start, int end,
425                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
426                    throws com.liferay.portal.kernel.exception.SystemException {
427                    return getService()
428                                       .getRecordVersions(recordId, start, end, orderByComparator);
429            }
430    
431            public static int getRecordVersionsCount(long recordId)
432                    throws com.liferay.portal.kernel.exception.SystemException {
433                    return getService().getRecordVersionsCount(recordId);
434            }
435    
436            public static void revertRecordVersion(long userId, long recordId,
437                    java.lang.String version,
438                    com.liferay.portal.service.ServiceContext serviceContext)
439                    throws com.liferay.portal.kernel.exception.PortalException,
440                            com.liferay.portal.kernel.exception.SystemException {
441                    getService()
442                            .revertRecordVersion(userId, recordId, version, serviceContext);
443            }
444    
445            public static com.liferay.portal.kernel.search.Hits search(
446                    com.liferay.portal.kernel.search.SearchContext searchContext)
447                    throws com.liferay.portal.kernel.exception.SystemException {
448                    return getService().search(searchContext);
449            }
450    
451            public static void updateAsset(long userId,
452                    com.liferay.portlet.dynamicdatalists.model.DDLRecord record,
453                    com.liferay.portlet.dynamicdatalists.model.DDLRecordVersion recordVersion,
454                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
455                    java.util.Locale locale)
456                    throws com.liferay.portal.kernel.exception.PortalException,
457                            com.liferay.portal.kernel.exception.SystemException {
458                    getService()
459                            .updateAsset(userId, record, recordVersion, assetCategoryIds,
460                            assetTagNames, locale);
461            }
462    
463            public static com.liferay.portlet.dynamicdatalists.model.DDLRecord updateRecord(
464                    long userId, long recordId, boolean majorVersion, int displayIndex,
465                    com.liferay.portlet.dynamicdatamapping.storage.Fields fields,
466                    boolean mergeFields,
467                    com.liferay.portal.service.ServiceContext serviceContext)
468                    throws com.liferay.portal.kernel.exception.PortalException,
469                            com.liferay.portal.kernel.exception.SystemException {
470                    return getService()
471                                       .updateRecord(userId, recordId, majorVersion, displayIndex,
472                            fields, mergeFields, serviceContext);
473            }
474    
475            public static com.liferay.portlet.dynamicdatalists.model.DDLRecord updateRecord(
476                    long userId, long recordId, int displayIndex,
477                    java.util.Map<java.lang.String, java.io.Serializable> fieldsMap,
478                    boolean mergeFields,
479                    com.liferay.portal.service.ServiceContext serviceContext)
480                    throws com.liferay.portal.kernel.exception.PortalException,
481                            com.liferay.portal.kernel.exception.SystemException {
482                    return getService()
483                                       .updateRecord(userId, recordId, displayIndex, fieldsMap,
484                            mergeFields, serviceContext);
485            }
486    
487            public static com.liferay.portlet.dynamicdatalists.model.DDLRecord updateStatus(
488                    long userId, long recordVersionId, int status,
489                    com.liferay.portal.service.ServiceContext serviceContext)
490                    throws com.liferay.portal.kernel.exception.PortalException,
491                            com.liferay.portal.kernel.exception.SystemException {
492                    return getService()
493                                       .updateStatus(userId, recordVersionId, status, serviceContext);
494            }
495    
496            public static DDLRecordLocalService getService() {
497                    if (_service == null) {
498                            _service = (DDLRecordLocalService)PortalBeanLocatorUtil.locate(DDLRecordLocalService.class.getName());
499    
500                            ReferenceRegistry.registerReference(DDLRecordLocalServiceUtil.class,
501                                    "_service");
502                    }
503    
504                    return _service;
505            }
506    
507            /**
508             * @deprecated
509             */
510            public void setService(DDLRecordLocalService service) {
511            }
512    
513            private static DDLRecordLocalService _service;
514    }