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.dynamicdatamapping.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.service.BaseLocalService;
026    import com.liferay.portal.service.PersistedModelLocalService;
027    
028    /**
029     * Provides the local service interface for DDMContent. Methods of this
030     * service will not have security checks based on the propagated JAAS
031     * credentials because this service can only be accessed from within the same
032     * VM.
033     *
034     * @author Brian Wing Shun Chan
035     * @see DDMContentLocalServiceUtil
036     * @see com.liferay.portlet.dynamicdatamapping.service.base.DDMContentLocalServiceBaseImpl
037     * @see com.liferay.portlet.dynamicdatamapping.service.impl.DDMContentLocalServiceImpl
038     * @generated
039     */
040    @ProviderType
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface DDMContentLocalService extends BaseLocalService,
044            PersistedModelLocalService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. Always use {@link DDMContentLocalServiceUtil} to access the d d m content local service. Add custom service methods to {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMContentLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
049             */
050            public com.liferay.portlet.dynamicdatamapping.model.DDMContent addContent(
051                    long userId, long groupId, java.lang.String name,
052                    java.lang.String description, java.lang.String data,
053                    com.liferay.portal.service.ServiceContext serviceContext)
054                    throws com.liferay.portal.kernel.exception.PortalException;
055    
056            /**
057            * Adds the d d m content to the database. Also notifies the appropriate model listeners.
058            *
059            * @param ddmContent the d d m content
060            * @return the d d m content that was added
061            */
062            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
063            public com.liferay.portlet.dynamicdatamapping.model.DDMContent addDDMContent(
064                    com.liferay.portlet.dynamicdatamapping.model.DDMContent ddmContent);
065    
066            /**
067            * Creates a new d d m content with the primary key. Does not add the d d m content to the database.
068            *
069            * @param contentId the primary key for the new d d m content
070            * @return the new d d m content
071            */
072            public com.liferay.portlet.dynamicdatamapping.model.DDMContent createDDMContent(
073                    long contentId);
074    
075            public void deleteContent(
076                    com.liferay.portlet.dynamicdatamapping.model.DDMContent content);
077    
078            public void deleteContents(long groupId);
079    
080            /**
081            * Deletes the d d m content with the primary key from the database. Also notifies the appropriate model listeners.
082            *
083            * @param contentId the primary key of the d d m content
084            * @return the d d m content that was removed
085            * @throws PortalException if a d d m content with the primary key could not be found
086            */
087            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
088            public com.liferay.portlet.dynamicdatamapping.model.DDMContent deleteDDMContent(
089                    long contentId)
090                    throws com.liferay.portal.kernel.exception.PortalException;
091    
092            /**
093            * Deletes the d d m content from the database. Also notifies the appropriate model listeners.
094            *
095            * @param ddmContent the d d m content
096            * @return the d d m content that was removed
097            */
098            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
099            public com.liferay.portlet.dynamicdatamapping.model.DDMContent deleteDDMContent(
100                    com.liferay.portlet.dynamicdatamapping.model.DDMContent ddmContent);
101    
102            /**
103            * @throws PortalException
104            */
105            @Override
106            public com.liferay.portal.model.PersistedModel deletePersistedModel(
107                    com.liferay.portal.model.PersistedModel persistedModel)
108                    throws com.liferay.portal.kernel.exception.PortalException;
109    
110            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
111    
112            /**
113            * Performs a dynamic query on the database and returns the matching rows.
114            *
115            * @param dynamicQuery the dynamic query
116            * @return the matching rows
117            */
118            public <T> java.util.List<T> dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
120    
121            /**
122            * Performs a dynamic query on the database and returns a range of the matching rows.
123            *
124            * <p>
125            * 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.dynamicdatamapping.model.impl.DDMContentModelImpl}. 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.
126            * </p>
127            *
128            * @param dynamicQuery the dynamic query
129            * @param start the lower bound of the range of model instances
130            * @param end the upper bound of the range of model instances (not inclusive)
131            * @return the range of matching rows
132            */
133            public <T> java.util.List<T> dynamicQuery(
134                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
135                    int end);
136    
137            /**
138            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
139            *
140            * <p>
141            * 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.dynamicdatamapping.model.impl.DDMContentModelImpl}. 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.
142            * </p>
143            *
144            * @param dynamicQuery the dynamic query
145            * @param start the lower bound of the range of model instances
146            * @param end the upper bound of the range of model instances (not inclusive)
147            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
148            * @return the ordered range of matching rows
149            */
150            public <T> java.util.List<T> dynamicQuery(
151                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
152                    int end,
153                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
154    
155            /**
156            * Returns the number of rows matching the dynamic query.
157            *
158            * @param dynamicQuery the dynamic query
159            * @return the number of rows matching the dynamic query
160            */
161            public long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
163    
164            /**
165            * Returns the number of rows matching the dynamic query.
166            *
167            * @param dynamicQuery the dynamic query
168            * @param projection the projection to apply to the query
169            * @return the number of rows matching the dynamic query
170            */
171            public long dynamicQueryCount(
172                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
173                    com.liferay.portal.kernel.dao.orm.Projection projection);
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public com.liferay.portlet.dynamicdatamapping.model.DDMContent fetchDDMContent(
177                    long contentId);
178    
179            /**
180            * Returns the d d m content matching the UUID and group.
181            *
182            * @param uuid the d d m content's UUID
183            * @param groupId the primary key of the group
184            * @return the matching d d m content, or <code>null</code> if a matching d d m content could not be found
185            */
186            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187            public com.liferay.portlet.dynamicdatamapping.model.DDMContent fetchDDMContentByUuidAndGroupId(
188                    java.lang.String uuid, long groupId);
189    
190            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
191            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
192    
193            /**
194            * Returns the Spring bean ID for this bean.
195            *
196            * @return the Spring bean ID for this bean
197            */
198            public java.lang.String getBeanIdentifier();
199    
200            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
201            public com.liferay.portlet.dynamicdatamapping.model.DDMContent getContent(
202                    long contentId)
203                    throws com.liferay.portal.kernel.exception.PortalException;
204    
205            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
206            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMContent> getContents();
207    
208            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMContent> getContents(
210                    long groupId);
211    
212            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
213            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMContent> getContents(
214                    long groupId, int start, int end);
215    
216            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
217            public int getContentsCount(long groupId);
218    
219            /**
220            * Returns the d d m content with the primary key.
221            *
222            * @param contentId the primary key of the d d m content
223            * @return the d d m content
224            * @throws PortalException if a d d m content with the primary key could not be found
225            */
226            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
227            public com.liferay.portlet.dynamicdatamapping.model.DDMContent getDDMContent(
228                    long contentId)
229                    throws com.liferay.portal.kernel.exception.PortalException;
230    
231            /**
232            * Returns the d d m content matching the UUID and group.
233            *
234            * @param uuid the d d m content's UUID
235            * @param groupId the primary key of the group
236            * @return the matching d d m content
237            * @throws PortalException if a matching d d m content could not be found
238            */
239            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
240            public com.liferay.portlet.dynamicdatamapping.model.DDMContent getDDMContentByUuidAndGroupId(
241                    java.lang.String uuid, long groupId)
242                    throws com.liferay.portal.kernel.exception.PortalException;
243    
244            /**
245            * Returns a range of all the d d m contents.
246            *
247            * <p>
248            * 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.dynamicdatamapping.model.impl.DDMContentModelImpl}. 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.
249            * </p>
250            *
251            * @param start the lower bound of the range of d d m contents
252            * @param end the upper bound of the range of d d m contents (not inclusive)
253            * @return the range of d d m contents
254            */
255            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
256            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMContent> getDDMContents(
257                    int start, int end);
258    
259            /**
260            * Returns all the d d m contents matching the UUID and company.
261            *
262            * @param uuid the UUID of the d d m contents
263            * @param companyId the primary key of the company
264            * @return the matching d d m contents, or an empty list if no matches were found
265            */
266            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
267            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMContent> getDDMContentsByUuidAndCompanyId(
268                    java.lang.String uuid, long companyId);
269    
270            /**
271            * Returns a range of d d m contents matching the UUID and company.
272            *
273            * @param uuid the UUID of the d d m contents
274            * @param companyId the primary key of the company
275            * @param start the lower bound of the range of d d m contents
276            * @param end the upper bound of the range of d d m contents (not inclusive)
277            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
278            * @return the range of matching d d m contents, or an empty list if no matches were found
279            */
280            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
281            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMContent> getDDMContentsByUuidAndCompanyId(
282                    java.lang.String uuid, long companyId, int start, int end,
283                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.dynamicdatamapping.model.DDMContent> orderByComparator);
284    
285            /**
286            * Returns the number of d d m contents.
287            *
288            * @return the number of d d m contents
289            */
290            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
291            public int getDDMContentsCount();
292    
293            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
294            public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(
295                    com.liferay.portal.kernel.lar.PortletDataContext portletDataContext);
296    
297            @Override
298            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
299            public com.liferay.portal.model.PersistedModel getPersistedModel(
300                    java.io.Serializable primaryKeyObj)
301                    throws com.liferay.portal.kernel.exception.PortalException;
302    
303            /**
304            * Sets the Spring bean ID for this bean.
305            *
306            * @param beanIdentifier the Spring bean ID for this bean
307            */
308            public void setBeanIdentifier(java.lang.String beanIdentifier);
309    
310            public com.liferay.portlet.dynamicdatamapping.model.DDMContent updateContent(
311                    long contentId, java.lang.String name, java.lang.String description,
312                    java.lang.String data,
313                    com.liferay.portal.service.ServiceContext serviceContext)
314                    throws com.liferay.portal.kernel.exception.PortalException;
315    
316            /**
317            * Updates the d d m content in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
318            *
319            * @param ddmContent the d d m content
320            * @return the d d m content that was updated
321            */
322            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
323            public com.liferay.portlet.dynamicdatamapping.model.DDMContent updateDDMContent(
324                    com.liferay.portlet.dynamicdatamapping.model.DDMContent ddmContent);
325    }