001    /**
002     * Copyright (c) 2000-2012 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 com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the layout set prototype local service. This utility wraps {@link com.liferay.portal.service.impl.LayoutSetPrototypeLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
023     *
024     * <p>
025     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see LayoutSetPrototypeLocalService
030     * @see com.liferay.portal.service.base.LayoutSetPrototypeLocalServiceBaseImpl
031     * @see com.liferay.portal.service.impl.LayoutSetPrototypeLocalServiceImpl
032     * @generated
033     */
034    public class LayoutSetPrototypeLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutSetPrototypeLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the layout set prototype to the database. Also notifies the appropriate model listeners.
043            *
044            * @param layoutSetPrototype the layout set prototype
045            * @return the layout set prototype that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portal.model.LayoutSetPrototype addLayoutSetPrototype(
049                    com.liferay.portal.model.LayoutSetPrototype layoutSetPrototype)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addLayoutSetPrototype(layoutSetPrototype);
052            }
053    
054            /**
055            * Creates a new layout set prototype with the primary key. Does not add the layout set prototype to the database.
056            *
057            * @param layoutSetPrototypeId the primary key for the new layout set prototype
058            * @return the new layout set prototype
059            */
060            public static com.liferay.portal.model.LayoutSetPrototype createLayoutSetPrototype(
061                    long layoutSetPrototypeId) {
062                    return getService().createLayoutSetPrototype(layoutSetPrototypeId);
063            }
064    
065            /**
066            * Deletes the layout set prototype with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param layoutSetPrototypeId the primary key of the layout set prototype
069            * @throws PortalException if a layout set prototype with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteLayoutSetPrototype(long layoutSetPrototypeId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteLayoutSetPrototype(layoutSetPrototypeId);
076            }
077    
078            /**
079            * Deletes the layout set prototype from the database. Also notifies the appropriate model listeners.
080            *
081            * @param layoutSetPrototype the layout set prototype
082            * @throws PortalException
083            * @throws SystemException if a system exception occurred
084            */
085            public static void deleteLayoutSetPrototype(
086                    com.liferay.portal.model.LayoutSetPrototype layoutSetPrototype)
087                    throws com.liferay.portal.kernel.exception.PortalException,
088                            com.liferay.portal.kernel.exception.SystemException {
089                    getService().deleteLayoutSetPrototype(layoutSetPrototype);
090            }
091    
092            /**
093            * Performs a dynamic query on the database and returns the matching rows.
094            *
095            * @param dynamicQuery the dynamic query
096            * @return the matching rows
097            * @throws SystemException if a system exception occurred
098            */
099            @SuppressWarnings("rawtypes")
100            public static java.util.List dynamicQuery(
101                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
102                    throws com.liferay.portal.kernel.exception.SystemException {
103                    return getService().dynamicQuery(dynamicQuery);
104            }
105    
106            /**
107            * Performs a dynamic query on the database and returns a range of the matching rows.
108            *
109            * <p>
110            * 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.
111            * </p>
112            *
113            * @param dynamicQuery the dynamic query
114            * @param start the lower bound of the range of model instances
115            * @param end the upper bound of the range of model instances (not inclusive)
116            * @return the range of matching rows
117            * @throws SystemException if a system exception occurred
118            */
119            @SuppressWarnings("rawtypes")
120            public static java.util.List dynamicQuery(
121                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
122                    int end) throws com.liferay.portal.kernel.exception.SystemException {
123                    return getService().dynamicQuery(dynamicQuery, start, end);
124            }
125    
126            /**
127            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
128            *
129            * <p>
130            * 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.
131            * </p>
132            *
133            * @param dynamicQuery the dynamic query
134            * @param start the lower bound of the range of model instances
135            * @param end the upper bound of the range of model instances (not inclusive)
136            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
137            * @return the ordered range of matching rows
138            * @throws SystemException if a system exception occurred
139            */
140            @SuppressWarnings("rawtypes")
141            public static java.util.List dynamicQuery(
142                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
143                    int end,
144                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
145                    throws com.liferay.portal.kernel.exception.SystemException {
146                    return getService()
147                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
148            }
149    
150            /**
151            * Returns the number of rows that match the dynamic query.
152            *
153            * @param dynamicQuery the dynamic query
154            * @return the number of rows that match the dynamic query
155            * @throws SystemException if a system exception occurred
156            */
157            public static long dynamicQueryCount(
158                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
159                    throws com.liferay.portal.kernel.exception.SystemException {
160                    return getService().dynamicQueryCount(dynamicQuery);
161            }
162    
163            public static com.liferay.portal.model.LayoutSetPrototype fetchLayoutSetPrototype(
164                    long layoutSetPrototypeId)
165                    throws com.liferay.portal.kernel.exception.SystemException {
166                    return getService().fetchLayoutSetPrototype(layoutSetPrototypeId);
167            }
168    
169            /**
170            * Returns the layout set prototype with the primary key.
171            *
172            * @param layoutSetPrototypeId the primary key of the layout set prototype
173            * @return the layout set prototype
174            * @throws PortalException if a layout set prototype with the primary key could not be found
175            * @throws SystemException if a system exception occurred
176            */
177            public static com.liferay.portal.model.LayoutSetPrototype getLayoutSetPrototype(
178                    long layoutSetPrototypeId)
179                    throws com.liferay.portal.kernel.exception.PortalException,
180                            com.liferay.portal.kernel.exception.SystemException {
181                    return getService().getLayoutSetPrototype(layoutSetPrototypeId);
182            }
183    
184            public static com.liferay.portal.model.PersistedModel getPersistedModel(
185                    java.io.Serializable primaryKeyObj)
186                    throws com.liferay.portal.kernel.exception.PortalException,
187                            com.liferay.portal.kernel.exception.SystemException {
188                    return getService().getPersistedModel(primaryKeyObj);
189            }
190    
191            /**
192            * Returns a range of all the layout set prototypes.
193            *
194            * <p>
195            * 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.
196            * </p>
197            *
198            * @param start the lower bound of the range of layout set prototypes
199            * @param end the upper bound of the range of layout set prototypes (not inclusive)
200            * @return the range of layout set prototypes
201            * @throws SystemException if a system exception occurred
202            */
203            public static java.util.List<com.liferay.portal.model.LayoutSetPrototype> getLayoutSetPrototypes(
204                    int start, int end)
205                    throws com.liferay.portal.kernel.exception.SystemException {
206                    return getService().getLayoutSetPrototypes(start, end);
207            }
208    
209            /**
210            * Returns the number of layout set prototypes.
211            *
212            * @return the number of layout set prototypes
213            * @throws SystemException if a system exception occurred
214            */
215            public static int getLayoutSetPrototypesCount()
216                    throws com.liferay.portal.kernel.exception.SystemException {
217                    return getService().getLayoutSetPrototypesCount();
218            }
219    
220            /**
221            * Updates the layout set prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
222            *
223            * @param layoutSetPrototype the layout set prototype
224            * @return the layout set prototype that was updated
225            * @throws SystemException if a system exception occurred
226            */
227            public static com.liferay.portal.model.LayoutSetPrototype updateLayoutSetPrototype(
228                    com.liferay.portal.model.LayoutSetPrototype layoutSetPrototype)
229                    throws com.liferay.portal.kernel.exception.SystemException {
230                    return getService().updateLayoutSetPrototype(layoutSetPrototype);
231            }
232    
233            /**
234            * Updates the layout set prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
235            *
236            * @param layoutSetPrototype the layout set prototype
237            * @param merge whether to merge the layout set prototype with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
238            * @return the layout set prototype that was updated
239            * @throws SystemException if a system exception occurred
240            */
241            public static com.liferay.portal.model.LayoutSetPrototype updateLayoutSetPrototype(
242                    com.liferay.portal.model.LayoutSetPrototype layoutSetPrototype,
243                    boolean merge)
244                    throws com.liferay.portal.kernel.exception.SystemException {
245                    return getService().updateLayoutSetPrototype(layoutSetPrototype, merge);
246            }
247    
248            /**
249            * Returns the Spring bean ID for this bean.
250            *
251            * @return the Spring bean ID for this bean
252            */
253            public static java.lang.String getBeanIdentifier() {
254                    return getService().getBeanIdentifier();
255            }
256    
257            /**
258            * Sets the Spring bean ID for this bean.
259            *
260            * @param beanIdentifier the Spring bean ID for this bean
261            */
262            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
263                    getService().setBeanIdentifier(beanIdentifier);
264            }
265    
266            public static com.liferay.portal.model.LayoutSetPrototype addLayoutSetPrototype(
267                    long userId, long companyId,
268                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
269                    java.lang.String description, boolean active,
270                    boolean layoutsUpdateable,
271                    com.liferay.portal.service.ServiceContext serviceContext)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException {
274                    return getService()
275                                       .addLayoutSetPrototype(userId, companyId, nameMap,
276                            description, active, layoutsUpdateable, serviceContext);
277            }
278    
279            public static com.liferay.portal.model.LayoutSetPrototype getLayoutSetPrototypeByUuid(
280                    java.lang.String uuid)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException {
283                    return getService().getLayoutSetPrototypeByUuid(uuid);
284            }
285    
286            public static java.util.List<com.liferay.portal.model.LayoutSetPrototype> search(
287                    long companyId, java.lang.Boolean active, int start, int end,
288                    com.liferay.portal.kernel.util.OrderByComparator obc)
289                    throws com.liferay.portal.kernel.exception.SystemException {
290                    return getService().search(companyId, active, start, end, obc);
291            }
292    
293            public static int searchCount(long companyId, java.lang.Boolean active)
294                    throws com.liferay.portal.kernel.exception.SystemException {
295                    return getService().searchCount(companyId, active);
296            }
297    
298            public static com.liferay.portal.model.LayoutSetPrototype updateLayoutSetPrototype(
299                    long layoutSetPrototypeId,
300                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
301                    java.lang.String description, boolean active,
302                    boolean layoutsUpdateable,
303                    com.liferay.portal.service.ServiceContext serviceContext)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException {
306                    return getService()
307                                       .updateLayoutSetPrototype(layoutSetPrototypeId, nameMap,
308                            description, active, layoutsUpdateable, serviceContext);
309            }
310    
311            public static com.liferay.portal.model.LayoutSetPrototype updateLayoutSetPrototype(
312                    long layoutSetPrototypeId, java.lang.String settings)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException {
315                    return getService()
316                                       .updateLayoutSetPrototype(layoutSetPrototypeId, settings);
317            }
318    
319            public static LayoutSetPrototypeLocalService getService() {
320                    if (_service == null) {
321                            _service = (LayoutSetPrototypeLocalService)PortalBeanLocatorUtil.locate(LayoutSetPrototypeLocalService.class.getName());
322    
323                            ReferenceRegistry.registerReference(LayoutSetPrototypeLocalServiceUtil.class,
324                                    "_service");
325                            MethodCache.remove(LayoutSetPrototypeLocalService.class);
326                    }
327    
328                    return _service;
329            }
330    
331            public void setService(LayoutSetPrototypeLocalService service) {
332                    MethodCache.remove(LayoutSetPrototypeLocalService.class);
333    
334                    _service = service;
335    
336                    ReferenceRegistry.registerReference(LayoutSetPrototypeLocalServiceUtil.class,
337                            "_service");
338                    MethodCache.remove(LayoutSetPrototypeLocalService.class);
339            }
340    
341            private static LayoutSetPrototypeLocalService _service;
342    }