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