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.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 DDMStructureLayout. 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 DDMStructureLayoutLocalServiceUtil
037     * @see com.liferay.portlet.dynamicdatamapping.service.base.DDMStructureLayoutLocalServiceBaseImpl
038     * @see com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLayoutLocalServiceImpl
039     * @generated
040     */
041    @ProviderType
042    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
043            PortalException.class, SystemException.class})
044    public interface DDMStructureLayoutLocalService extends BaseLocalService,
045            PersistedModelLocalService {
046            /*
047             * NOTE FOR DEVELOPERS:
048             *
049             * Never modify or reference this interface directly. Always use {@link DDMStructureLayoutLocalServiceUtil} to access the d d m structure layout local service. Add custom service methods to {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLayoutLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
050             */
051    
052            /**
053            * Adds the d d m structure layout to the database. Also notifies the appropriate model listeners.
054            *
055            * @param ddmStructureLayout the d d m structure layout
056            * @return the d d m structure layout that was added
057            */
058            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
059            public com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout addDDMStructureLayout(
060                    com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout ddmStructureLayout);
061    
062            public com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout addStructureLayout(
063                    long userId, long groupId, long structureVersionId,
064                    com.liferay.portlet.dynamicdatamapping.model.DDMFormLayout ddmFormLayout,
065                    com.liferay.portal.service.ServiceContext serviceContext)
066                    throws PortalException;
067    
068            /**
069            * Creates a new d d m structure layout with the primary key. Does not add the d d m structure layout to the database.
070            *
071            * @param structureLayoutId the primary key for the new d d m structure layout
072            * @return the new d d m structure layout
073            */
074            public com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout createDDMStructureLayout(
075                    long structureLayoutId);
076    
077            /**
078            * Deletes the d d m structure layout from the database. Also notifies the appropriate model listeners.
079            *
080            * @param ddmStructureLayout the d d m structure layout
081            * @return the d d m structure layout that was removed
082            */
083            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
084            public com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout deleteDDMStructureLayout(
085                    com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout ddmStructureLayout);
086    
087            /**
088            * Deletes the d d m structure layout with the primary key from the database. Also notifies the appropriate model listeners.
089            *
090            * @param structureLayoutId the primary key of the d d m structure layout
091            * @return the d d m structure layout that was removed
092            * @throws PortalException if a d d m structure layout with the primary key could not be found
093            */
094            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
095            public com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout deleteDDMStructureLayout(
096                    long structureLayoutId) throws PortalException;
097    
098            /**
099            * @throws PortalException
100            */
101            @Override
102            public com.liferay.portal.model.PersistedModel deletePersistedModel(
103                    com.liferay.portal.model.PersistedModel persistedModel)
104                    throws PortalException;
105    
106            @com.liferay.portal.kernel.systemevent.SystemEvent(type = SystemEventConstants.TYPE_DELETE)
107            public void deleteStructureLayout(
108                    com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout structureLayout);
109    
110            public void deleteStructureLayout(long structureLayoutId)
111                    throws PortalException;
112    
113            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
114    
115            /**
116            * Performs a dynamic query on the database and returns the matching rows.
117            *
118            * @param dynamicQuery the dynamic query
119            * @return the matching rows
120            */
121            public <T> java.util.List<T> dynamicQuery(
122                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
123    
124            /**
125            * Performs a dynamic query on the database and returns a 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. 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.DDMStructureLayoutModelImpl}. 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.
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            * @return the range of matching rows
135            */
136            public <T> java.util.List<T> dynamicQuery(
137                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
138                    int end);
139    
140            /**
141            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
142            *
143            * <p>
144            * 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.DDMStructureLayoutModelImpl}. 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.
145            * </p>
146            *
147            * @param dynamicQuery the dynamic query
148            * @param start the lower bound of the range of model instances
149            * @param end the upper bound of the range of model instances (not inclusive)
150            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
151            * @return the ordered range of matching rows
152            */
153            public <T> java.util.List<T> dynamicQuery(
154                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
155                    int end,
156                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
157    
158            /**
159            * Returns the number of rows matching the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @return the number of rows matching the dynamic query
163            */
164            public long dynamicQueryCount(
165                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
166    
167            /**
168            * Returns the number of rows matching the dynamic query.
169            *
170            * @param dynamicQuery the dynamic query
171            * @param projection the projection to apply to the query
172            * @return the number of rows matching the dynamic query
173            */
174            public long dynamicQueryCount(
175                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
176                    com.liferay.portal.kernel.dao.orm.Projection projection);
177    
178            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179            public com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout fetchDDMStructureLayout(
180                    long structureLayoutId);
181    
182            /**
183            * Returns the d d m structure layout matching the UUID and group.
184            *
185            * @param uuid the d d m structure layout's UUID
186            * @param groupId the primary key of the group
187            * @return the matching d d m structure layout, or <code>null</code> if a matching d d m structure layout could not be found
188            */
189            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
190            public com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout fetchDDMStructureLayoutByUuidAndGroupId(
191                    java.lang.String uuid, long groupId);
192    
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
195    
196            /**
197            * Returns the Spring bean ID for this bean.
198            *
199            * @return the Spring bean ID for this bean
200            */
201            public java.lang.String getBeanIdentifier();
202    
203            /**
204            * Returns the d d m structure layout with the primary key.
205            *
206            * @param structureLayoutId the primary key of the d d m structure layout
207            * @return the d d m structure layout
208            * @throws PortalException if a d d m structure layout with the primary key could not be found
209            */
210            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
211            public com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout getDDMStructureLayout(
212                    long structureLayoutId) throws PortalException;
213    
214            /**
215            * Returns the d d m structure layout matching the UUID and group.
216            *
217            * @param uuid the d d m structure layout's UUID
218            * @param groupId the primary key of the group
219            * @return the matching d d m structure layout
220            * @throws PortalException if a matching d d m structure layout could not be found
221            */
222            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
223            public com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout getDDMStructureLayoutByUuidAndGroupId(
224                    java.lang.String uuid, long groupId) throws PortalException;
225    
226            /**
227            * Returns a range of all the d d m structure layouts.
228            *
229            * <p>
230            * 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.DDMStructureLayoutModelImpl}. 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.
231            * </p>
232            *
233            * @param start the lower bound of the range of d d m structure layouts
234            * @param end the upper bound of the range of d d m structure layouts (not inclusive)
235            * @return the range of d d m structure layouts
236            */
237            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
238            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout> getDDMStructureLayouts(
239                    int start, int end);
240    
241            /**
242            * Returns all the d d m structure layouts matching the UUID and company.
243            *
244            * @param uuid the UUID of the d d m structure layouts
245            * @param companyId the primary key of the company
246            * @return the matching d d m structure layouts, or an empty list if no matches were found
247            */
248            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
249            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout> getDDMStructureLayoutsByUuidAndCompanyId(
250                    java.lang.String uuid, long companyId);
251    
252            /**
253            * Returns a range of d d m structure layouts matching the UUID and company.
254            *
255            * @param uuid the UUID of the d d m structure layouts
256            * @param companyId the primary key of the company
257            * @param start the lower bound of the range of d d m structure layouts
258            * @param end the upper bound of the range of d d m structure layouts (not inclusive)
259            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
260            * @return the range of matching d d m structure layouts, or an empty list if no matches were found
261            */
262            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
263            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout> getDDMStructureLayoutsByUuidAndCompanyId(
264                    java.lang.String uuid, long companyId, int start, int end,
265                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout> orderByComparator);
266    
267            /**
268            * Returns the number of d d m structure layouts.
269            *
270            * @return the number of d d m structure layouts
271            */
272            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
273            public int getDDMStructureLayoutsCount();
274    
275            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
276            public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(
277                    com.liferay.portlet.exportimport.lar.PortletDataContext portletDataContext);
278    
279            @Override
280            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
281            public com.liferay.portal.model.PersistedModel getPersistedModel(
282                    java.io.Serializable primaryKeyObj) throws PortalException;
283    
284            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
285            public com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout getStructureLayout(
286                    long structureLayoutId) throws PortalException;
287    
288            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
289            public com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout getStructureLayoutByStructureVersionId(
290                    long structureVersionId) throws PortalException;
291    
292            /**
293            * Sets the Spring bean ID for this bean.
294            *
295            * @param beanIdentifier the Spring bean ID for this bean
296            */
297            public void setBeanIdentifier(java.lang.String beanIdentifier);
298    
299            /**
300            * Updates the d d m structure layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
301            *
302            * @param ddmStructureLayout the d d m structure layout
303            * @return the d d m structure layout that was updated
304            */
305            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
306            public com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout updateDDMStructureLayout(
307                    com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout ddmStructureLayout);
308    
309            public com.liferay.portlet.dynamicdatamapping.model.DDMStructureLayout updateStructureLayout(
310                    long structureLayoutId,
311                    com.liferay.portlet.dynamicdatamapping.model.DDMFormLayout ddmFormLayout,
312                    com.liferay.portal.service.ServiceContext serviceContext)
313                    throws PortalException;
314    }