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 aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.transaction.Isolation;
022    import com.liferay.portal.kernel.transaction.Propagation;
023    import com.liferay.portal.kernel.transaction.Transactional;
024    import com.liferay.portal.service.BaseLocalService;
025    import com.liferay.portal.service.PersistedModelLocalService;
026    
027    /**
028     * Provides the local service interface for DDLRecordSet. Methods of this
029     * service will not have security checks based on the propagated JAAS
030     * credentials because this service can only be accessed from within the same
031     * VM.
032     *
033     * @author Brian Wing Shun Chan
034     * @see DDLRecordSetLocalServiceUtil
035     * @see com.liferay.portlet.dynamicdatalists.service.base.DDLRecordSetLocalServiceBaseImpl
036     * @see com.liferay.portlet.dynamicdatalists.service.impl.DDLRecordSetLocalServiceImpl
037     * @generated
038     */
039    @ProviderType
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface DDLRecordSetLocalService extends BaseLocalService,
043            PersistedModelLocalService {
044            /*
045             * NOTE FOR DEVELOPERS:
046             *
047             * 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.
048             */
049    
050            /**
051            * Adds the d d l record set to the database. Also notifies the appropriate model listeners.
052            *
053            * @param ddlRecordSet the d d l record set
054            * @return the d d l record set that was added
055            * @throws SystemException if a system exception occurred
056            */
057            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet addDDLRecordSet(
058                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet ddlRecordSet)
059                    throws com.liferay.portal.kernel.exception.SystemException;
060    
061            /**
062            * Creates a new d d l record set with the primary key. Does not add the d d l record set to the database.
063            *
064            * @param recordSetId the primary key for the new d d l record set
065            * @return the new d d l record set
066            */
067            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet createDDLRecordSet(
068                    long recordSetId);
069    
070            /**
071            * Deletes the d d l record set with the primary key from the database. Also notifies the appropriate model listeners.
072            *
073            * @param recordSetId the primary key of the d d l record set
074            * @return the d d l record set that was removed
075            * @throws PortalException if a d d l record set with the primary key could not be found
076            * @throws SystemException if a system exception occurred
077            */
078            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet deleteDDLRecordSet(
079                    long recordSetId)
080                    throws com.liferay.portal.kernel.exception.PortalException,
081                            com.liferay.portal.kernel.exception.SystemException;
082    
083            /**
084            * Deletes the d d l record set from the database. Also notifies the appropriate model listeners.
085            *
086            * @param ddlRecordSet the d d l record set
087            * @return the d d l record set that was removed
088            * @throws SystemException if a system exception occurred
089            */
090            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet deleteDDLRecordSet(
091                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet ddlRecordSet)
092                    throws com.liferay.portal.kernel.exception.SystemException;
093    
094            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
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 java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException;
107    
108            /**
109            * Performs a dynamic query on the database and returns a range of the matching rows.
110            *
111            * <p>
112            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.dynamicdatalists.model.impl.DDLRecordSetModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
113            * </p>
114            *
115            * @param dynamicQuery the dynamic query
116            * @param start the lower bound of the range of model instances
117            * @param end the upper bound of the range of model instances (not inclusive)
118            * @return the range of matching rows
119            * @throws SystemException if a system exception occurred
120            */
121            @SuppressWarnings("rawtypes")
122            public java.util.List dynamicQuery(
123                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
124                    int end) throws com.liferay.portal.kernel.exception.SystemException;
125    
126            /**
127            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
128            *
129            * <p>
130            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.dynamicdatalists.model.impl.DDLRecordSetModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
131            * </p>
132            *
133            * @param dynamicQuery the dynamic query
134            * @param start the lower bound of the range of model instances
135            * @param end the upper bound of the range of model instances (not inclusive)
136            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
137            * @return the ordered range of matching rows
138            * @throws SystemException if a system exception occurred
139            */
140            @SuppressWarnings("rawtypes")
141            public java.util.List dynamicQuery(
142                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
143                    int end,
144                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
145                    throws com.liferay.portal.kernel.exception.SystemException;
146    
147            /**
148            * Returns the number of rows that match the dynamic query.
149            *
150            * @param dynamicQuery the dynamic query
151            * @return the number of rows that match the dynamic query
152            * @throws SystemException if a system exception occurred
153            */
154            public long dynamicQueryCount(
155                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
156                    throws com.liferay.portal.kernel.exception.SystemException;
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @param projection the projection to apply to the query
163            * @return the number of rows that match the dynamic query
164            * @throws SystemException if a system exception occurred
165            */
166            public long dynamicQueryCount(
167                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
168                    com.liferay.portal.kernel.dao.orm.Projection projection)
169                    throws com.liferay.portal.kernel.exception.SystemException;
170    
171            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet fetchDDLRecordSet(
173                    long recordSetId)
174                    throws com.liferay.portal.kernel.exception.SystemException;
175    
176            /**
177            * Returns the d d l record set with the matching UUID and company.
178            *
179            * @param uuid the d d l record set's UUID
180            * @param companyId the primary key of the company
181            * @return the matching d d l record set, or <code>null</code> if a matching d d l record set could not be found
182            * @throws SystemException if a system exception occurred
183            */
184            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet fetchDDLRecordSetByUuidAndCompanyId(
186                    java.lang.String uuid, long companyId)
187                    throws com.liferay.portal.kernel.exception.SystemException;
188    
189            /**
190            * Returns the d d l record set matching the UUID and group.
191            *
192            * @param uuid the d d l record set's UUID
193            * @param groupId the primary key of the group
194            * @return the matching d d l record set, or <code>null</code> if a matching d d l record set could not be found
195            * @throws SystemException if a system exception occurred
196            */
197            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
198            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet fetchDDLRecordSetByUuidAndGroupId(
199                    java.lang.String uuid, long groupId)
200                    throws com.liferay.portal.kernel.exception.SystemException;
201    
202            /**
203            * Returns the d d l record set with the primary key.
204            *
205            * @param recordSetId the primary key of the d d l record set
206            * @return the d d l record set
207            * @throws PortalException if a d d l record set with the primary key could not be found
208            * @throws SystemException if a system exception occurred
209            */
210            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
211            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet getDDLRecordSet(
212                    long recordSetId)
213                    throws com.liferay.portal.kernel.exception.PortalException,
214                            com.liferay.portal.kernel.exception.SystemException;
215    
216            @Override
217            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218            public com.liferay.portal.model.PersistedModel getPersistedModel(
219                    java.io.Serializable primaryKeyObj)
220                    throws com.liferay.portal.kernel.exception.PortalException,
221                            com.liferay.portal.kernel.exception.SystemException;
222    
223            /**
224            * Returns the d d l record set with the matching UUID and company.
225            *
226            * @param uuid the d d l record set's UUID
227            * @param companyId the primary key of the company
228            * @return the matching d d l record set
229            * @throws PortalException if a matching d d l record set could not be found
230            * @throws SystemException if a system exception occurred
231            */
232            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
233            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet getDDLRecordSetByUuidAndCompanyId(
234                    java.lang.String uuid, long companyId)
235                    throws com.liferay.portal.kernel.exception.PortalException,
236                            com.liferay.portal.kernel.exception.SystemException;
237    
238            /**
239            * Returns the d d l record set matching the UUID and group.
240            *
241            * @param uuid the d d l record set's UUID
242            * @param groupId the primary key of the group
243            * @return the matching d d l record set
244            * @throws PortalException if a matching d d l record set could not be found
245            * @throws SystemException if a system exception occurred
246            */
247            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
248            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet getDDLRecordSetByUuidAndGroupId(
249                    java.lang.String uuid, long groupId)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException;
252    
253            /**
254            * Returns a range of all the d d l record sets.
255            *
256            * <p>
257            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.dynamicdatalists.model.impl.DDLRecordSetModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
258            * </p>
259            *
260            * @param start the lower bound of the range of d d l record sets
261            * @param end the upper bound of the range of d d l record sets (not inclusive)
262            * @return the range of d d l record sets
263            * @throws SystemException if a system exception occurred
264            */
265            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
266            public java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecordSet> getDDLRecordSets(
267                    int start, int end)
268                    throws com.liferay.portal.kernel.exception.SystemException;
269    
270            /**
271            * Returns the number of d d l record sets.
272            *
273            * @return the number of d d l record sets
274            * @throws SystemException if a system exception occurred
275            */
276            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
277            public int getDDLRecordSetsCount()
278                    throws com.liferay.portal.kernel.exception.SystemException;
279    
280            /**
281            * 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.
282            *
283            * @param ddlRecordSet the d d l record set
284            * @return the d d l record set that was updated
285            * @throws SystemException if a system exception occurred
286            */
287            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateDDLRecordSet(
288                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet ddlRecordSet)
289                    throws com.liferay.portal.kernel.exception.SystemException;
290    
291            /**
292            * Returns the Spring bean ID for this bean.
293            *
294            * @return the Spring bean ID for this bean
295            */
296            public java.lang.String getBeanIdentifier();
297    
298            /**
299            * Sets the Spring bean ID for this bean.
300            *
301            * @param beanIdentifier the Spring bean ID for this bean
302            */
303            public void setBeanIdentifier(java.lang.String beanIdentifier);
304    
305            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet addRecordSet(
306                    long userId, long groupId, long ddmStructureId,
307                    java.lang.String recordSetKey,
308                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
309                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
310                    int minDisplayRows, int scope,
311                    com.liferay.portal.service.ServiceContext serviceContext)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException;
314    
315            public void addRecordSetResources(
316                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet recordSet,
317                    boolean addGroupPermissions, boolean addGuestPermissions)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException;
320    
321            public void addRecordSetResources(
322                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet recordSet,
323                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException;
326    
327            public void deleteRecordSet(
328                    com.liferay.portlet.dynamicdatalists.model.DDLRecordSet recordSet)
329                    throws com.liferay.portal.kernel.exception.PortalException,
330                            com.liferay.portal.kernel.exception.SystemException;
331    
332            public void deleteRecordSet(long recordSetId)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException;
335    
336            public void deleteRecordSet(long groupId, java.lang.String recordSetKey)
337                    throws com.liferay.portal.kernel.exception.PortalException,
338                            com.liferay.portal.kernel.exception.SystemException;
339    
340            public void deleteRecordSets(long groupId)
341                    throws com.liferay.portal.kernel.exception.PortalException,
342                            com.liferay.portal.kernel.exception.SystemException;
343    
344            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
345            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet fetchRecordSet(
346                    long recordSetId)
347                    throws com.liferay.portal.kernel.exception.SystemException;
348    
349            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
350            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet fetchRecordSet(
351                    long groupId, java.lang.String recordSetKey)
352                    throws com.liferay.portal.kernel.exception.SystemException;
353    
354            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
355            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet getRecordSet(
356                    long recordSetId)
357                    throws com.liferay.portal.kernel.exception.PortalException,
358                            com.liferay.portal.kernel.exception.SystemException;
359    
360            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
361            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet getRecordSet(
362                    long groupId, java.lang.String recordSetKey)
363                    throws com.liferay.portal.kernel.exception.PortalException,
364                            com.liferay.portal.kernel.exception.SystemException;
365    
366            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
367            public java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecordSet> getRecordSets(
368                    long groupId)
369                    throws com.liferay.portal.kernel.exception.SystemException;
370    
371            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
372            public int getRecordSetsCount(long groupId)
373                    throws com.liferay.portal.kernel.exception.SystemException;
374    
375            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
376            public java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecordSet> search(
377                    long companyId, long groupId, java.lang.String keywords, int scope,
378                    int start, int end,
379                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
380                    throws com.liferay.portal.kernel.exception.SystemException;
381    
382            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
383            public java.util.List<com.liferay.portlet.dynamicdatalists.model.DDLRecordSet> search(
384                    long companyId, long groupId, java.lang.String name,
385                    java.lang.String description, int scope, boolean andOperator,
386                    int start, int end,
387                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
388                    throws com.liferay.portal.kernel.exception.SystemException;
389    
390            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
391            public int searchCount(long companyId, long groupId,
392                    java.lang.String keywords, int scope)
393                    throws com.liferay.portal.kernel.exception.SystemException;
394    
395            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
396            public int searchCount(long companyId, long groupId, java.lang.String name,
397                    java.lang.String description, int scope, boolean andOperator)
398                    throws com.liferay.portal.kernel.exception.SystemException;
399    
400            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateMinDisplayRows(
401                    long recordSetId, int minDisplayRows,
402                    com.liferay.portal.service.ServiceContext serviceContext)
403                    throws com.liferay.portal.kernel.exception.PortalException,
404                            com.liferay.portal.kernel.exception.SystemException;
405    
406            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateRecordSet(
407                    long recordSetId, long ddmStructureId,
408                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
409                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
410                    int minDisplayRows,
411                    com.liferay.portal.service.ServiceContext serviceContext)
412                    throws com.liferay.portal.kernel.exception.PortalException,
413                            com.liferay.portal.kernel.exception.SystemException;
414    
415            public com.liferay.portlet.dynamicdatalists.model.DDLRecordSet updateRecordSet(
416                    long groupId, long ddmStructureId, java.lang.String recordSetKey,
417                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
418                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
419                    int minDisplayRows,
420                    com.liferay.portal.service.ServiceContext serviceContext)
421                    throws com.liferay.portal.kernel.exception.PortalException,
422                            com.liferay.portal.kernel.exception.SystemException;
423    }