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.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    import com.liferay.portal.service.BaseLocalService;
023    import com.liferay.portal.service.PersistedModelLocalService;
024    
025    /**
026     * The interface for the d d l record local service.
027     *
028     * <p>
029     * 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.
030     * </p>
031     *
032     * @author Brian Wing Shun Chan
033     * @see DDLRecordLocalServiceUtil
034     * @see com.liferay.portlet.dynamicdatalists.service.base.DDLRecordLocalServiceBaseImpl
035     * @see com.liferay.portlet.dynamicdatalists.service.impl.DDLRecordLocalServiceImpl
036     * @generated
037     */
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface DDLRecordLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * Never modify or reference this interface directly. Always use {@link DDLRecordLocalServiceUtil} to access the d d l record local service. Add custom service methods to {@link com.liferay.portlet.dynamicdatalists.service.impl.DDLRecordLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
046             */
047    
048            /**
049            * Adds the d d l record to the database. Also notifies the appropriate model listeners.
050            *
051            * @param ddlRecord the d d l record
052            * @return the d d l record that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portlet.dynamicdatalists.model.DDLRecord addDDLRecord(
056                    com.liferay.portlet.dynamicdatalists.model.DDLRecord ddlRecord)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new d d l record with the primary key. Does not add the d d l record to the database.
061            *
062            * @param recordId the primary key for the new d d l record
063            * @return the new d d l record
064            */
065            public com.liferay.portlet.dynamicdatalists.model.DDLRecord createDDLRecord(
066                    long recordId);
067    
068            /**
069            * Deletes the d d l record with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param recordId the primary key of the d d l record
072            * @return the d d l record that was removed
073            * @throws PortalException if a d d l record with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public com.liferay.portlet.dynamicdatalists.model.DDLRecord deleteDDLRecord(
077                    long recordId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            /**
082            * Deletes the d d l record from the database. Also notifies the appropriate model listeners.
083            *
084            * @param ddlRecord the d d l record
085            * @return the d d l record that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public com.liferay.portlet.dynamicdatalists.model.DDLRecord deleteDDLRecord(
089                    com.liferay.portlet.dynamicdatalists.model.DDLRecord ddlRecord)
090                    throws com.liferay.portal.kernel.exception.SystemException;
091    
092            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
093    
094            /**
095            * Performs a dynamic query on the database and returns the matching rows.
096            *
097            * @param dynamicQuery the dynamic query
098            * @return the matching rows
099            * @throws SystemException if a system exception occurred
100            */
101            @SuppressWarnings("rawtypes")
102            public java.util.List dynamicQuery(
103                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
104                    throws com.liferay.portal.kernel.exception.SystemException;
105    
106            /**
107            * Performs a dynamic query on the database and returns a range of the matching rows.
108            *
109            * <p>
110            * 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.
111            * </p>
112            *
113            * @param dynamicQuery the dynamic query
114            * @param start the lower bound of the range of model instances
115            * @param end the upper bound of the range of model instances (not inclusive)
116            * @return the range of matching rows
117            * @throws SystemException if a system exception occurred
118            */
119            @SuppressWarnings("rawtypes")
120            public java.util.List dynamicQuery(
121                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
122                    int end) throws com.liferay.portal.kernel.exception.SystemException;
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException;
144    
145            /**
146            * Returns the number of rows that match the dynamic query.
147            *
148            * @param dynamicQuery the dynamic query
149            * @return the number of rows that match the dynamic query
150            * @throws SystemException if a system exception occurred
151            */
152            public long dynamicQueryCount(
153                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
154                    throws com.liferay.portal.kernel.exception.SystemException;
155    
156            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
157            public com.liferay.portlet.dynamicdatalists.model.DDLRecord fetchDDLRecord(
158                    long recordId)
159                    throws com.liferay.portal.kernel.exception.SystemException;
160    
161            /**
162            * Returns the d d l record with the primary key.
163            *
164            * @param recordId the primary key of the d d l record
165            * @return the d d l record
166            * @throws PortalException if a d d l record with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portlet.dynamicdatalists.model.DDLRecord getDDLRecord(
171                    long recordId)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException;
180    
181            /**
182            * Returns the d d l record with the UUID in the group.
183            *
184            * @param uuid the UUID of d d l record
185            * @param groupId the group id of the d d l record
186            * @return the d d l record
187            * @throws PortalException if a d d l record with the UUID in the group could not be found
188            * @throws SystemException if a system exception occurred
189            */
190            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
191            public com.liferay.portlet.dynamicdatalists.model.DDLRecord getDDLRecordByUuidAndGroupId(
192                    java.lang.String uuid, long groupId)
193                    throws com.liferay.portal.kernel.exception.PortalException,
194                            com.liferay.portal.kernel.exception.SystemException;
195    
196            /**
197            * Returns a range of all the d d l records.
198            *
199            * <p>
200            * 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.
201            * </p>
202            *
203            * @param start the lower bound of the range of d d l records
204            * @param end the upper bound of the range of d d l records (not inclusive)
205            * @return the range of d d l records
206            * @throws SystemException if a system exception occurred
207            */
208            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209            public java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecord> getDDLRecords(
210                    int start, int end)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Returns the number of d d l records.
215            *
216            * @return the number of d d l records
217            * @throws SystemException if a system exception occurred
218            */
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public int getDDLRecordsCount()
221                    throws com.liferay.portal.kernel.exception.SystemException;
222    
223            /**
224            * Updates the d d l record in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
225            *
226            * @param ddlRecord the d d l record
227            * @return the d d l record that was updated
228            * @throws SystemException if a system exception occurred
229            */
230            public com.liferay.portlet.dynamicdatalists.model.DDLRecord updateDDLRecord(
231                    com.liferay.portlet.dynamicdatalists.model.DDLRecord ddlRecord)
232                    throws com.liferay.portal.kernel.exception.SystemException;
233    
234            /**
235            * Returns the Spring bean ID for this bean.
236            *
237            * @return the Spring bean ID for this bean
238            */
239            public java.lang.String getBeanIdentifier();
240    
241            /**
242            * Sets the Spring bean ID for this bean.
243            *
244            * @param beanIdentifier the Spring bean ID for this bean
245            */
246            public void setBeanIdentifier(java.lang.String beanIdentifier);
247    
248            public com.liferay.portlet.dynamicdatalists.model.DDLRecord addRecord(
249                    long userId, long groupId, long recordSetId, int displayIndex,
250                    com.liferay.portlet.dynamicdatamapping.storage.Fields fields,
251                    com.liferay.portal.service.ServiceContext serviceContext)
252                    throws com.liferay.portal.kernel.exception.PortalException,
253                            com.liferay.portal.kernel.exception.SystemException;
254    
255            public com.liferay.portlet.dynamicdatalists.model.DDLRecord addRecord(
256                    long userId, long groupId, long recordSetId, int displayIndex,
257                    java.util.Map<java.lang.String, java.io.Serializable> fieldsMap,
258                    com.liferay.portal.service.ServiceContext serviceContext)
259                    throws com.liferay.portal.kernel.exception.PortalException,
260                            com.liferay.portal.kernel.exception.SystemException;
261    
262            public void deleteRecord(
263                    com.liferay.portlet.dynamicdatalists.model.DDLRecord record)
264                    throws com.liferay.portal.kernel.exception.PortalException,
265                            com.liferay.portal.kernel.exception.SystemException;
266    
267            public void deleteRecord(long recordId)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException;
270    
271            public void deleteRecords(long recordSetId)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException;
274    
275            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
276            public com.liferay.portlet.dynamicdatalists.model.DDLRecord fetchRecord(
277                    long recordId)
278                    throws com.liferay.portal.kernel.exception.SystemException;
279    
280            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
281            public java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecord> getCompanyRecords(
282                    long companyId, int status, int scope, int start, int end,
283                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
284                    throws com.liferay.portal.kernel.exception.SystemException;
285    
286            /**
287            * @deprecated {@link #getCompanyRecords(long, int, int, int, int,
288            OrderByComparator)}
289            */
290            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
291            public java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecord> getCompanyRecords(
292                    long companyId, int scope, int start, int end,
293                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
294                    throws com.liferay.portal.kernel.exception.SystemException;
295    
296            /**
297            * @deprecated {@link #getCompanyRecordsCount(long, int, int)}
298            */
299            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
300            public int getCompanyRecordsCount(long companyId, int scope)
301                    throws com.liferay.portal.kernel.exception.SystemException;
302    
303            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
304            public int getCompanyRecordsCount(long companyId, int status, int scope)
305                    throws com.liferay.portal.kernel.exception.SystemException;
306    
307            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
308            public com.liferay.portlet.dynamicdatalists.model.DDLRecordVersion getLatestRecordVersion(
309                    long recordId)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException;
312    
313            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
314            public java.lang.Long[] getMinAndMaxCompanyRecordIds(long companyId,
315                    int status, int scope)
316                    throws com.liferay.portal.kernel.exception.SystemException;
317    
318            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
319            public java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecord> getMinAndMaxCompanyRecords(
320                    long companyId, int status, int scope, long minRecordId,
321                    long maxRecordId)
322                    throws com.liferay.portal.kernel.exception.SystemException;
323    
324            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
325            public com.liferay.portlet.dynamicdatalists.model.DDLRecord getRecord(
326                    long recordId)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException;
329    
330            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
331            public java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecord> getRecords(
332                    long recordSetId)
333                    throws com.liferay.portal.kernel.exception.SystemException;
334    
335            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
336            public java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecord> getRecords(
337                    long recordSetId, int status, int start, int end,
338                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
339                    throws com.liferay.portal.kernel.exception.SystemException;
340    
341            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
342            public java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecord> getRecords(
343                    long recordSetId, long userId)
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public int getRecordsCount(long recordSetId, int status)
348                    throws com.liferay.portal.kernel.exception.SystemException;
349    
350            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
351            public com.liferay.portlet.dynamicdatalists.model.DDLRecordVersion getRecordVersion(
352                    long recordVersionId)
353                    throws com.liferay.portal.kernel.exception.PortalException,
354                            com.liferay.portal.kernel.exception.SystemException;
355    
356            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
357            public com.liferay.portlet.dynamicdatalists.model.DDLRecordVersion getRecordVersion(
358                    long recordId, java.lang.String version)
359                    throws com.liferay.portal.kernel.exception.PortalException,
360                            com.liferay.portal.kernel.exception.SystemException;
361    
362            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
363            public java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecordVersion> getRecordVersions(
364                    long recordId, int start, int end,
365                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
366                    throws com.liferay.portal.kernel.exception.SystemException;
367    
368            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
369            public int getRecordVersionsCount(long recordId)
370                    throws com.liferay.portal.kernel.exception.SystemException;
371    
372            public void revertRecordVersion(long userId, long recordId,
373                    java.lang.String version,
374                    com.liferay.portal.service.ServiceContext serviceContext)
375                    throws com.liferay.portal.kernel.exception.PortalException,
376                            com.liferay.portal.kernel.exception.SystemException;
377    
378            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
379            public com.liferay.portal.kernel.search.Hits search(
380                    com.liferay.portal.kernel.search.SearchContext searchContext)
381                    throws com.liferay.portal.kernel.exception.SystemException;
382    
383            public void updateAsset(long userId,
384                    com.liferay.portlet.dynamicdatalists.model.DDLRecord record,
385                    com.liferay.portlet.dynamicdatalists.model.DDLRecordVersion recordVersion,
386                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
387                    java.util.Locale locale)
388                    throws com.liferay.portal.kernel.exception.PortalException,
389                            com.liferay.portal.kernel.exception.SystemException;
390    
391            public com.liferay.portlet.dynamicdatalists.model.DDLRecord updateRecord(
392                    long userId, long recordId, boolean majorVersion, int displayIndex,
393                    com.liferay.portlet.dynamicdatamapping.storage.Fields fields,
394                    boolean mergeFields,
395                    com.liferay.portal.service.ServiceContext serviceContext)
396                    throws com.liferay.portal.kernel.exception.PortalException,
397                            com.liferay.portal.kernel.exception.SystemException;
398    
399            public com.liferay.portlet.dynamicdatalists.model.DDLRecord updateRecord(
400                    long userId, long recordId, int displayIndex,
401                    java.util.Map<java.lang.String, java.io.Serializable> fieldsMap,
402                    boolean mergeFields,
403                    com.liferay.portal.service.ServiceContext serviceContext)
404                    throws com.liferay.portal.kernel.exception.PortalException,
405                            com.liferay.portal.kernel.exception.SystemException;
406    
407            public com.liferay.portlet.dynamicdatalists.model.DDLRecord updateStatus(
408                    long userId, long recordVersionId, int status,
409                    com.liferay.portal.service.ServiceContext serviceContext)
410                    throws com.liferay.portal.kernel.exception.PortalException,
411                            com.liferay.portal.kernel.exception.SystemException;
412    }