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.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the local service utility for DDMStructureVersion. This utility wraps
024     * {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureVersionLocalServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on the local server. Methods of this service will not have security checks
027     * based on the propagated JAAS credentials because this service can only be
028     * accessed from within the same VM.
029     *
030     * @author Brian Wing Shun Chan
031     * @see DDMStructureVersionLocalService
032     * @see com.liferay.portlet.dynamicdatamapping.service.base.DDMStructureVersionLocalServiceBaseImpl
033     * @see com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureVersionLocalServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class DDMStructureVersionLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureVersionLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
042             */
043    
044            /**
045            * Adds the d d m structure version to the database. Also notifies the appropriate model listeners.
046            *
047            * @param ddmStructureVersion the d d m structure version
048            * @return the d d m structure version that was added
049            */
050            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion addDDMStructureVersion(
051                    com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion ddmStructureVersion) {
052                    return getService().addDDMStructureVersion(ddmStructureVersion);
053            }
054    
055            /**
056            * Creates a new d d m structure version with the primary key. Does not add the d d m structure version to the database.
057            *
058            * @param structureVersionId the primary key for the new d d m structure version
059            * @return the new d d m structure version
060            */
061            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion createDDMStructureVersion(
062                    long structureVersionId) {
063                    return getService().createDDMStructureVersion(structureVersionId);
064            }
065    
066            /**
067            * Deletes the d d m structure version from the database. Also notifies the appropriate model listeners.
068            *
069            * @param ddmStructureVersion the d d m structure version
070            * @return the d d m structure version that was removed
071            */
072            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion deleteDDMStructureVersion(
073                    com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion ddmStructureVersion) {
074                    return getService().deleteDDMStructureVersion(ddmStructureVersion);
075            }
076    
077            /**
078            * Deletes the d d m structure version with the primary key from the database. Also notifies the appropriate model listeners.
079            *
080            * @param structureVersionId the primary key of the d d m structure version
081            * @return the d d m structure version that was removed
082            * @throws PortalException if a d d m structure version with the primary key could not be found
083            */
084            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion deleteDDMStructureVersion(
085                    long structureVersionId)
086                    throws com.liferay.portal.kernel.exception.PortalException {
087                    return getService().deleteDDMStructureVersion(structureVersionId);
088            }
089    
090            /**
091            * @throws PortalException
092            */
093            public static com.liferay.portal.model.PersistedModel deletePersistedModel(
094                    com.liferay.portal.model.PersistedModel persistedModel)
095                    throws com.liferay.portal.kernel.exception.PortalException {
096                    return getService().deletePersistedModel(persistedModel);
097            }
098    
099            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
100                    return getService().dynamicQuery();
101            }
102    
103            /**
104            * Performs a dynamic query on the database and returns the matching rows.
105            *
106            * @param dynamicQuery the dynamic query
107            * @return the matching rows
108            */
109            public static <T> java.util.List<T> dynamicQuery(
110                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
111                    return getService().dynamicQuery(dynamicQuery);
112            }
113    
114            /**
115            * Performs a dynamic query on the database and returns a range of the matching rows.
116            *
117            * <p>
118            * 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.DDMStructureVersionModelImpl}. 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query
122            * @param start the lower bound of the range of model instances
123            * @param end the upper bound of the range of model instances (not inclusive)
124            * @return the range of matching rows
125            */
126            public static <T> java.util.List<T> dynamicQuery(
127                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
128                    int end) {
129                    return getService().dynamicQuery(dynamicQuery, start, end);
130            }
131    
132            /**
133            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
134            *
135            * <p>
136            * 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.DDMStructureVersionModelImpl}. 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.
137            * </p>
138            *
139            * @param dynamicQuery the dynamic query
140            * @param start the lower bound of the range of model instances
141            * @param end the upper bound of the range of model instances (not inclusive)
142            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
143            * @return the ordered range of matching rows
144            */
145            public static <T> java.util.List<T> dynamicQuery(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
147                    int end,
148                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) {
149                    return getService()
150                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
151            }
152    
153            /**
154            * Returns the number of rows matching the dynamic query.
155            *
156            * @param dynamicQuery the dynamic query
157            * @return the number of rows matching the dynamic query
158            */
159            public static long dynamicQueryCount(
160                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
161                    return getService().dynamicQueryCount(dynamicQuery);
162            }
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 static long dynamicQueryCount(
172                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
173                    com.liferay.portal.kernel.dao.orm.Projection projection) {
174                    return getService().dynamicQueryCount(dynamicQuery, projection);
175            }
176    
177            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion fetchDDMStructureVersion(
178                    long structureVersionId) {
179                    return getService().fetchDDMStructureVersion(structureVersionId);
180            }
181    
182            public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() {
183                    return getService().getActionableDynamicQuery();
184            }
185    
186            /**
187            * Returns the Spring bean ID for this bean.
188            *
189            * @return the Spring bean ID for this bean
190            */
191            public static java.lang.String getBeanIdentifier() {
192                    return getService().getBeanIdentifier();
193            }
194    
195            /**
196            * Returns the d d m structure version with the primary key.
197            *
198            * @param structureVersionId the primary key of the d d m structure version
199            * @return the d d m structure version
200            * @throws PortalException if a d d m structure version with the primary key could not be found
201            */
202            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion getDDMStructureVersion(
203                    long structureVersionId)
204                    throws com.liferay.portal.kernel.exception.PortalException {
205                    return getService().getDDMStructureVersion(structureVersionId);
206            }
207    
208            /**
209            * Returns a range of all the d d m structure versions.
210            *
211            * <p>
212            * 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.DDMStructureVersionModelImpl}. 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.
213            * </p>
214            *
215            * @param start the lower bound of the range of d d m structure versions
216            * @param end the upper bound of the range of d d m structure versions (not inclusive)
217            * @return the range of d d m structure versions
218            */
219            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion> getDDMStructureVersions(
220                    int start, int end) {
221                    return getService().getDDMStructureVersions(start, end);
222            }
223    
224            /**
225            * Returns the number of d d m structure versions.
226            *
227            * @return the number of d d m structure versions
228            */
229            public static int getDDMStructureVersionsCount() {
230                    return getService().getDDMStructureVersionsCount();
231            }
232    
233            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion getLatestStructureVersion(
234                    long structureId)
235                    throws com.liferay.portal.kernel.exception.PortalException {
236                    return getService().getLatestStructureVersion(structureId);
237            }
238    
239            public static com.liferay.portal.model.PersistedModel getPersistedModel(
240                    java.io.Serializable primaryKeyObj)
241                    throws com.liferay.portal.kernel.exception.PortalException {
242                    return getService().getPersistedModel(primaryKeyObj);
243            }
244    
245            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion getStructureVersion(
246                    long structureId, java.lang.String version)
247                    throws com.liferay.portal.kernel.exception.PortalException {
248                    return getService().getStructureVersion(structureId, version);
249            }
250    
251            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion getStructureVersion(
252                    long structureVersionId)
253                    throws com.liferay.portal.kernel.exception.PortalException {
254                    return getService().getStructureVersion(structureVersionId);
255            }
256    
257            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion> getStructureVersions(
258                    long structureId) {
259                    return getService().getStructureVersions(structureId);
260            }
261    
262            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion> getStructureVersions(
263                    long structureId, int start, int end,
264                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion> orderByComparator) {
265                    return getService()
266                                       .getStructureVersions(structureId, start, end,
267                            orderByComparator);
268            }
269    
270            public static int getStructureVersionsCount(long structureId) {
271                    return getService().getStructureVersionsCount(structureId);
272            }
273    
274            /**
275            * Sets the Spring bean ID for this bean.
276            *
277            * @param beanIdentifier the Spring bean ID for this bean
278            */
279            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
280                    getService().setBeanIdentifier(beanIdentifier);
281            }
282    
283            /**
284            * Updates the d d m structure version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
285            *
286            * @param ddmStructureVersion the d d m structure version
287            * @return the d d m structure version that was updated
288            */
289            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion updateDDMStructureVersion(
290                    com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion ddmStructureVersion) {
291                    return getService().updateDDMStructureVersion(ddmStructureVersion);
292            }
293    
294            public static DDMStructureVersionLocalService getService() {
295                    if (_service == null) {
296                            _service = (DDMStructureVersionLocalService)PortalBeanLocatorUtil.locate(DDMStructureVersionLocalService.class.getName());
297    
298                            ReferenceRegistry.registerReference(DDMStructureVersionLocalServiceUtil.class,
299                                    "_service");
300                    }
301    
302                    return _service;
303            }
304    
305            /**
306             * @deprecated As of 6.2.0
307             */
308            @Deprecated
309            public void setService(DDMStructureVersionLocalService service) {
310            }
311    
312            private static DDMStructureVersionLocalService _service;
313    }