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