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.portal.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 LayoutSetPrototype. This utility wraps
024     * {@link com.liferay.portal.service.impl.LayoutSetPrototypeLocalServiceImpl} 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 LayoutSetPrototypeLocalService
032     * @see com.liferay.portal.service.base.LayoutSetPrototypeLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.LayoutSetPrototypeLocalServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class LayoutSetPrototypeLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutSetPrototypeLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
042             */
043    
044            /**
045            * Adds the layout set prototype to the database. Also notifies the appropriate model listeners.
046            *
047            * @param layoutSetPrototype the layout set prototype
048            * @return the layout set prototype that was added
049            * @throws SystemException if a system exception occurred
050            */
051            public static com.liferay.portal.model.LayoutSetPrototype addLayoutSetPrototype(
052                    com.liferay.portal.model.LayoutSetPrototype layoutSetPrototype)
053                    throws com.liferay.portal.kernel.exception.SystemException {
054                    return getService().addLayoutSetPrototype(layoutSetPrototype);
055            }
056    
057            /**
058            * Creates a new layout set prototype with the primary key. Does not add the layout set prototype to the database.
059            *
060            * @param layoutSetPrototypeId the primary key for the new layout set prototype
061            * @return the new layout set prototype
062            */
063            public static com.liferay.portal.model.LayoutSetPrototype createLayoutSetPrototype(
064                    long layoutSetPrototypeId) {
065                    return getService().createLayoutSetPrototype(layoutSetPrototypeId);
066            }
067    
068            /**
069            * Deletes the layout set prototype with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param layoutSetPrototypeId the primary key of the layout set prototype
072            * @return the layout set prototype that was removed
073            * @throws PortalException if a layout set prototype with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public static com.liferay.portal.model.LayoutSetPrototype deleteLayoutSetPrototype(
077                    long layoutSetPrototypeId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException {
080                    return getService().deleteLayoutSetPrototype(layoutSetPrototypeId);
081            }
082    
083            /**
084            * Deletes the layout set prototype from the database. Also notifies the appropriate model listeners.
085            *
086            * @param layoutSetPrototype the layout set prototype
087            * @return the layout set prototype that was removed
088            * @throws PortalException
089            * @throws SystemException if a system exception occurred
090            */
091            public static com.liferay.portal.model.LayoutSetPrototype deleteLayoutSetPrototype(
092                    com.liferay.portal.model.LayoutSetPrototype layoutSetPrototype)
093                    throws com.liferay.portal.kernel.exception.PortalException,
094                            com.liferay.portal.kernel.exception.SystemException {
095                    return getService().deleteLayoutSetPrototype(layoutSetPrototype);
096            }
097    
098            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
099                    return getService().dynamicQuery();
100            }
101    
102            /**
103            * Performs a dynamic query on the database and returns the matching rows.
104            *
105            * @param dynamicQuery the dynamic query
106            * @return the matching rows
107            * @throws SystemException if a system exception occurred
108            */
109            @SuppressWarnings("rawtypes")
110            public static java.util.List dynamicQuery(
111                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
112                    throws com.liferay.portal.kernel.exception.SystemException {
113                    return getService().dynamicQuery(dynamicQuery);
114            }
115    
116            /**
117            * Performs a dynamic query on the database and returns a range of the matching rows.
118            *
119            * <p>
120            * 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.portal.model.impl.LayoutSetPrototypeModelImpl}. 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.
121            * </p>
122            *
123            * @param dynamicQuery the dynamic query
124            * @param start the lower bound of the range of model instances
125            * @param end the upper bound of the range of model instances (not inclusive)
126            * @return the range of matching rows
127            * @throws SystemException if a system exception occurred
128            */
129            @SuppressWarnings("rawtypes")
130            public static java.util.List dynamicQuery(
131                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
132                    int end) throws com.liferay.portal.kernel.exception.SystemException {
133                    return getService().dynamicQuery(dynamicQuery, start, end);
134            }
135    
136            /**
137            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
138            *
139            * <p>
140            * 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.portal.model.impl.LayoutSetPrototypeModelImpl}. 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.
141            * </p>
142            *
143            * @param dynamicQuery the dynamic query
144            * @param start the lower bound of the range of model instances
145            * @param end the upper bound of the range of model instances (not inclusive)
146            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
147            * @return the ordered range of matching rows
148            * @throws SystemException if a system exception occurred
149            */
150            @SuppressWarnings("rawtypes")
151            public static java.util.List dynamicQuery(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
153                    int end,
154                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
155                    throws com.liferay.portal.kernel.exception.SystemException {
156                    return getService()
157                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
158            }
159    
160            /**
161            * Returns the number of rows that match the dynamic query.
162            *
163            * @param dynamicQuery the dynamic query
164            * @return the number of rows that match the dynamic query
165            * @throws SystemException if a system exception occurred
166            */
167            public static long dynamicQueryCount(
168                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().dynamicQueryCount(dynamicQuery);
171            }
172    
173            /**
174            * Returns the number of rows that match the dynamic query.
175            *
176            * @param dynamicQuery the dynamic query
177            * @param projection the projection to apply to the query
178            * @return the number of rows that match the dynamic query
179            * @throws SystemException if a system exception occurred
180            */
181            public static long dynamicQueryCount(
182                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
183                    com.liferay.portal.kernel.dao.orm.Projection projection)
184                    throws com.liferay.portal.kernel.exception.SystemException {
185                    return getService().dynamicQueryCount(dynamicQuery, projection);
186            }
187    
188            public static com.liferay.portal.model.LayoutSetPrototype fetchLayoutSetPrototype(
189                    long layoutSetPrototypeId)
190                    throws com.liferay.portal.kernel.exception.SystemException {
191                    return getService().fetchLayoutSetPrototype(layoutSetPrototypeId);
192            }
193    
194            /**
195            * Returns the layout set prototype with the matching UUID and company.
196            *
197            * @param uuid the layout set prototype's UUID
198            * @param companyId the primary key of the company
199            * @return the matching layout set prototype, or <code>null</code> if a matching layout set prototype could not be found
200            * @throws SystemException if a system exception occurred
201            */
202            public static com.liferay.portal.model.LayoutSetPrototype fetchLayoutSetPrototypeByUuidAndCompanyId(
203                    java.lang.String uuid, long companyId)
204                    throws com.liferay.portal.kernel.exception.SystemException {
205                    return getService()
206                                       .fetchLayoutSetPrototypeByUuidAndCompanyId(uuid, companyId);
207            }
208    
209            /**
210            * Returns the layout set prototype with the primary key.
211            *
212            * @param layoutSetPrototypeId the primary key of the layout set prototype
213            * @return the layout set prototype
214            * @throws PortalException if a layout set prototype with the primary key could not be found
215            * @throws SystemException if a system exception occurred
216            */
217            public static com.liferay.portal.model.LayoutSetPrototype getLayoutSetPrototype(
218                    long layoutSetPrototypeId)
219                    throws com.liferay.portal.kernel.exception.PortalException,
220                            com.liferay.portal.kernel.exception.SystemException {
221                    return getService().getLayoutSetPrototype(layoutSetPrototypeId);
222            }
223    
224            public static com.liferay.portal.model.PersistedModel getPersistedModel(
225                    java.io.Serializable primaryKeyObj)
226                    throws com.liferay.portal.kernel.exception.PortalException,
227                            com.liferay.portal.kernel.exception.SystemException {
228                    return getService().getPersistedModel(primaryKeyObj);
229            }
230    
231            /**
232            * Returns the layout set prototype with the matching UUID and company.
233            *
234            * @param uuid the layout set prototype's UUID
235            * @param companyId the primary key of the company
236            * @return the matching layout set prototype
237            * @throws PortalException if a matching layout set prototype could not be found
238            * @throws SystemException if a system exception occurred
239            */
240            public static com.liferay.portal.model.LayoutSetPrototype getLayoutSetPrototypeByUuidAndCompanyId(
241                    java.lang.String uuid, long companyId)
242                    throws com.liferay.portal.kernel.exception.PortalException,
243                            com.liferay.portal.kernel.exception.SystemException {
244                    return getService()
245                                       .getLayoutSetPrototypeByUuidAndCompanyId(uuid, companyId);
246            }
247    
248            /**
249            * Returns a range of all the layout set prototypes.
250            *
251            * <p>
252            * 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.portal.model.impl.LayoutSetPrototypeModelImpl}. 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.
253            * </p>
254            *
255            * @param start the lower bound of the range of layout set prototypes
256            * @param end the upper bound of the range of layout set prototypes (not inclusive)
257            * @return the range of layout set prototypes
258            * @throws SystemException if a system exception occurred
259            */
260            public static java.util.List<com.liferay.portal.model.LayoutSetPrototype> getLayoutSetPrototypes(
261                    int start, int end)
262                    throws com.liferay.portal.kernel.exception.SystemException {
263                    return getService().getLayoutSetPrototypes(start, end);
264            }
265    
266            /**
267            * Returns the number of layout set prototypes.
268            *
269            * @return the number of layout set prototypes
270            * @throws SystemException if a system exception occurred
271            */
272            public static int getLayoutSetPrototypesCount()
273                    throws com.liferay.portal.kernel.exception.SystemException {
274                    return getService().getLayoutSetPrototypesCount();
275            }
276    
277            /**
278            * Updates the layout set prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
279            *
280            * @param layoutSetPrototype the layout set prototype
281            * @return the layout set prototype that was updated
282            * @throws SystemException if a system exception occurred
283            */
284            public static com.liferay.portal.model.LayoutSetPrototype updateLayoutSetPrototype(
285                    com.liferay.portal.model.LayoutSetPrototype layoutSetPrototype)
286                    throws com.liferay.portal.kernel.exception.SystemException {
287                    return getService().updateLayoutSetPrototype(layoutSetPrototype);
288            }
289    
290            /**
291            * Returns the Spring bean ID for this bean.
292            *
293            * @return the Spring bean ID for this bean
294            */
295            public static java.lang.String getBeanIdentifier() {
296                    return getService().getBeanIdentifier();
297            }
298    
299            /**
300            * Sets the Spring bean ID for this bean.
301            *
302            * @param beanIdentifier the Spring bean ID for this bean
303            */
304            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
305                    getService().setBeanIdentifier(beanIdentifier);
306            }
307    
308            public static com.liferay.portal.model.LayoutSetPrototype addLayoutSetPrototype(
309                    long userId, long companyId,
310                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
311                    java.lang.String description, boolean active,
312                    boolean layoutsUpdateable,
313                    com.liferay.portal.service.ServiceContext serviceContext)
314                    throws com.liferay.portal.kernel.exception.PortalException,
315                            com.liferay.portal.kernel.exception.SystemException {
316                    return getService()
317                                       .addLayoutSetPrototype(userId, companyId, nameMap,
318                            description, active, layoutsUpdateable, serviceContext);
319            }
320    
321            public static void deleteLayoutSetPrototypes()
322                    throws com.liferay.portal.kernel.exception.PortalException,
323                            com.liferay.portal.kernel.exception.SystemException {
324                    getService().deleteLayoutSetPrototypes();
325            }
326    
327            public static void deleteNondefaultLayoutSetPrototypes(long companyId)
328                    throws com.liferay.portal.kernel.exception.PortalException,
329                            com.liferay.portal.kernel.exception.SystemException {
330                    getService().deleteNondefaultLayoutSetPrototypes(companyId);
331            }
332    
333            /**
334            * @deprecated As of 6.2.0, replaced by {@link
335            #getLayoutSetPrototypeByUuidAndCompanyId(String, long)}
336            */
337            public static com.liferay.portal.model.LayoutSetPrototype getLayoutSetPrototypeByUuid(
338                    java.lang.String uuid)
339                    throws com.liferay.portal.kernel.exception.PortalException,
340                            com.liferay.portal.kernel.exception.SystemException {
341                    return getService().getLayoutSetPrototypeByUuid(uuid);
342            }
343    
344            public static java.util.List<com.liferay.portal.model.LayoutSetPrototype> getLayoutSetPrototypes(
345                    long companyId)
346                    throws com.liferay.portal.kernel.exception.SystemException {
347                    return getService().getLayoutSetPrototypes(companyId);
348            }
349    
350            public static java.util.List<com.liferay.portal.model.LayoutSetPrototype> search(
351                    long companyId, java.lang.Boolean active, int start, int end,
352                    com.liferay.portal.kernel.util.OrderByComparator obc)
353                    throws com.liferay.portal.kernel.exception.SystemException {
354                    return getService().search(companyId, active, start, end, obc);
355            }
356    
357            public static int searchCount(long companyId, java.lang.Boolean active)
358                    throws com.liferay.portal.kernel.exception.SystemException {
359                    return getService().searchCount(companyId, active);
360            }
361    
362            public static com.liferay.portal.model.LayoutSetPrototype updateLayoutSetPrototype(
363                    long layoutSetPrototypeId,
364                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
365                    java.lang.String description, boolean active,
366                    boolean layoutsUpdateable,
367                    com.liferay.portal.service.ServiceContext serviceContext)
368                    throws com.liferay.portal.kernel.exception.PortalException,
369                            com.liferay.portal.kernel.exception.SystemException {
370                    return getService()
371                                       .updateLayoutSetPrototype(layoutSetPrototypeId, nameMap,
372                            description, active, layoutsUpdateable, serviceContext);
373            }
374    
375            public static com.liferay.portal.model.LayoutSetPrototype updateLayoutSetPrototype(
376                    long layoutSetPrototypeId, java.lang.String settings)
377                    throws com.liferay.portal.kernel.exception.PortalException,
378                            com.liferay.portal.kernel.exception.SystemException {
379                    return getService()
380                                       .updateLayoutSetPrototype(layoutSetPrototypeId, settings);
381            }
382    
383            public static LayoutSetPrototypeLocalService getService() {
384                    if (_service == null) {
385                            _service = (LayoutSetPrototypeLocalService)PortalBeanLocatorUtil.locate(LayoutSetPrototypeLocalService.class.getName());
386    
387                            ReferenceRegistry.registerReference(LayoutSetPrototypeLocalServiceUtil.class,
388                                    "_service");
389                    }
390    
391                    return _service;
392            }
393    
394            /**
395             * @deprecated As of 6.2.0
396             */
397            public void setService(LayoutSetPrototypeLocalService service) {
398            }
399    
400            private static LayoutSetPrototypeLocalService _service;
401    }