001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.dynamicdatalists.service;
016    
017    import com.liferay.portal.kernel.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 set 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 DDLRecordSetLocalServiceUtil
034     * @see com.liferay.portlet.dynamicdatalists.service.base.DDLRecordSetLocalServiceBaseImpl
035     * @see com.liferay.portlet.dynamicdatalists.service.impl.DDLRecordSetLocalServiceImpl
036     * @generated
037     */
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface DDLRecordSetLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * Never modify or reference this interface directly. Always use {@link DDLRecordSetLocalServiceUtil} to access the d d l record set local service. Add custom service methods to {@link com.liferay.portlet.dynamicdatalists.service.impl.DDLRecordSetLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
046             */
047    
048            /**
049            * Adds the d d l record set to the database. Also notifies the appropriate model listeners.
050            *
051            * @param ddlRecordSet the d d l record set
052            * @return the d d l record set that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet addDDLRecordSet(
056                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet ddlRecordSet)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new d d l record set with the primary key. Does not add the d d l record set to the database.
061            *
062            * @param recordSetId the primary key for the new d d l record set
063            * @return the new d d l record set
064            */
065            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet createDDLRecordSet(
066                    long recordSetId);
067    
068            /**
069            * Deletes the d d l record set with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param recordSetId the primary key of the d d l record set
072            * @return the d d l record set that was removed
073            * @throws PortalException if a d d l record set with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet deleteDDLRecordSet(
077                    long recordSetId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            /**
082            * Deletes the d d l record set from the database. Also notifies the appropriate model listeners.
083            *
084            * @param ddlRecordSet the d d l record set
085            * @return the d d l record set that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet deleteDDLRecordSet(
089                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet ddlRecordSet)
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.DDLRecordSet fetchDDLRecordSet(
158                    long recordSetId)
159                    throws com.liferay.portal.kernel.exception.SystemException;
160    
161            /**
162            * Returns the d d l record set with the primary key.
163            *
164            * @param recordSetId the primary key of the d d l record set
165            * @return the d d l record set
166            * @throws PortalException if a d d l record set 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.DDLRecordSet getDDLRecordSet(
171                    long recordSetId)
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 set with the UUID in the group.
183            *
184            * @param uuid the UUID of d d l record set
185            * @param groupId the group id of the d d l record set
186            * @return the d d l record set
187            * @throws PortalException if a d d l record set 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.DDLRecordSet getDDLRecordSetByUuidAndGroupId(
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 record sets.
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 record sets
204            * @param end the upper bound of the range of d d l record sets (not inclusive)
205            * @return the range of d d l record sets
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.DDLRecordSet> getDDLRecordSets(
210                    int start, int end)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Returns the number of d d l record sets.
215            *
216            * @return the number of d d l record sets
217            * @throws SystemException if a system exception occurred
218            */
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public int getDDLRecordSetsCount()
221                    throws com.liferay.portal.kernel.exception.SystemException;
222    
223            /**
224            * 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.
225            *
226            * @param ddlRecordSet the d d l record set
227            * @return the d d l record set that was updated
228            * @throws SystemException if a system exception occurred
229            */
230            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateDDLRecordSet(
231                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet ddlRecordSet)
232                    throws com.liferay.portal.kernel.exception.SystemException;
233    
234            /**
235            * 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.
236            *
237            * @param ddlRecordSet the d d l record set
238            * @param merge whether to merge the d d l record set with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
239            * @return the d d l record set that was updated
240            * @throws SystemException if a system exception occurred
241            */
242            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateDDLRecordSet(
243                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet ddlRecordSet,
244                    boolean merge)
245                    throws com.liferay.portal.kernel.exception.SystemException;
246    
247            /**
248            * Returns the Spring bean ID for this bean.
249            *
250            * @return the Spring bean ID for this bean
251            */
252            public java.lang.String getBeanIdentifier();
253    
254            /**
255            * Sets the Spring bean ID for this bean.
256            *
257            * @param beanIdentifier the Spring bean ID for this bean
258            */
259            public void setBeanIdentifier(java.lang.String beanIdentifier);
260    
261            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet addRecordSet(
262                    long userId, long groupId, long ddmStructureId,
263                    java.lang.String recordSetKey,
264                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
265                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
266                    int minDisplayRows, int scope,
267                    com.liferay.portal.service.ServiceContext serviceContext)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException;
270    
271            public void addRecordSetResources(
272                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet recordSet,
273                    boolean addGroupPermissions, boolean addGuestPermissions)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException;
276    
277            public void addRecordSetResources(
278                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet recordSet,
279                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException;
282    
283            public void deleteRecordSet(
284                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet recordSet)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            public void deleteRecordSet(long recordSetId)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException;
291    
292            public void deleteRecordSet(long groupId, java.lang.String recordSetKey)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException;
295    
296            public void deleteRecordSets(long groupId)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException;
299    
300            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
301            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet fetchRecordSet(
302                    long groupId, java.lang.String recordSetKey)
303                    throws com.liferay.portal.kernel.exception.SystemException;
304    
305            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
306            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet getRecordSet(
307                    long recordSetId)
308                    throws com.liferay.portal.kernel.exception.PortalException,
309                            com.liferay.portal.kernel.exception.SystemException;
310    
311            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
312            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet getRecordSet(
313                    long groupId, java.lang.String recordSetKey)
314                    throws com.liferay.portal.kernel.exception.PortalException,
315                            com.liferay.portal.kernel.exception.SystemException;
316    
317            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
318            public java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecordSet> getRecordSets(
319                    long groupId)
320                    throws com.liferay.portal.kernel.exception.SystemException;
321    
322            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
323            public int getRecordSetsCount(long groupId)
324                    throws com.liferay.portal.kernel.exception.SystemException;
325    
326            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
327            public java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecordSet> search(
328                    long companyId, long groupId, java.lang.String keywords, int scope,
329                    int start, int end,
330                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
331                    throws com.liferay.portal.kernel.exception.SystemException;
332    
333            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
334            public java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecordSet> search(
335                    long companyId, long groupId, java.lang.String name,
336                    java.lang.String description, int scope, boolean andOperator,
337                    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 int searchCount(long companyId, long groupId,
343                    java.lang.String keywords, int scope)
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public int searchCount(long companyId, long groupId, java.lang.String name,
348                    java.lang.String description, int scope, boolean andOperator)
349                    throws com.liferay.portal.kernel.exception.SystemException;
350    
351            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateMinDisplayRows(
352                    long recordSetId, int minDisplayRows,
353                    com.liferay.portal.service.ServiceContext serviceContext)
354                    throws com.liferay.portal.kernel.exception.PortalException,
355                            com.liferay.portal.kernel.exception.SystemException;
356    
357            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateRecordSet(
358                    long recordSetId, long ddmStructureId,
359                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
360                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
361                    int minDisplayRows,
362                    com.liferay.portal.service.ServiceContext serviceContext)
363                    throws com.liferay.portal.kernel.exception.PortalException,
364                            com.liferay.portal.kernel.exception.SystemException;
365    
366            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateRecordSet(
367                    long groupId, long ddmStructureId, java.lang.String recordSetKey,
368                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
369                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
370                    int minDisplayRows,
371                    com.liferay.portal.service.ServiceContext serviceContext)
372                    throws com.liferay.portal.kernel.exception.PortalException,
373                            com.liferay.portal.kernel.exception.SystemException;
374    }