001    /**
002     * Copyright (c) 2000-2011 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 portlet item local service. This utility wraps {@link com.liferay.portal.service.impl.PortletItemLocalServiceImpl} 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 PortletItemLocalService
030     * @see com.liferay.portal.service.base.PortletItemLocalServiceBaseImpl
031     * @see com.liferay.portal.service.impl.PortletItemLocalServiceImpl
032     * @generated
033     */
034    public class PortletItemLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.PortletItemLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the portlet item to the database. Also notifies the appropriate model listeners.
043            *
044            * @param portletItem the portlet item
045            * @return the portlet item that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portal.model.PortletItem addPortletItem(
049                    com.liferay.portal.model.PortletItem portletItem)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addPortletItem(portletItem);
052            }
053    
054            /**
055            * Creates a new portlet item with the primary key. Does not add the portlet item to the database.
056            *
057            * @param portletItemId the primary key for the new portlet item
058            * @return the new portlet item
059            */
060            public static com.liferay.portal.model.PortletItem createPortletItem(
061                    long portletItemId) {
062                    return getService().createPortletItem(portletItemId);
063            }
064    
065            /**
066            * Deletes the portlet item with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param portletItemId the primary key of the portlet item
069            * @throws PortalException if a portlet item with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deletePortletItem(long portletItemId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deletePortletItem(portletItemId);
076            }
077    
078            /**
079            * Deletes the portlet item from the database. Also notifies the appropriate model listeners.
080            *
081            * @param portletItem the portlet item
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deletePortletItem(
085                    com.liferay.portal.model.PortletItem portletItem)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deletePortletItem(portletItem);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered 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.
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            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            /**
162            * Returns the portlet item with the primary key.
163            *
164            * @param portletItemId the primary key of the portlet item
165            * @return the portlet item
166            * @throws PortalException if a portlet item with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portal.model.PortletItem getPortletItem(
170                    long portletItemId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getPortletItem(portletItemId);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns a range of all the portlet items.
185            *
186            * <p>
187            * 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.
188            * </p>
189            *
190            * @param start the lower bound of the range of portlet items
191            * @param end the upper bound of the range of portlet items (not inclusive)
192            * @return the range of portlet items
193            * @throws SystemException if a system exception occurred
194            */
195            public static java.util.List<com.liferay.portal.model.PortletItem> getPortletItems(
196                    int start, int end)
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getPortletItems(start, end);
199            }
200    
201            /**
202            * Returns the number of portlet items.
203            *
204            * @return the number of portlet items
205            * @throws SystemException if a system exception occurred
206            */
207            public static int getPortletItemsCount()
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getPortletItemsCount();
210            }
211    
212            /**
213            * Updates the portlet item in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param portletItem the portlet item
216            * @return the portlet item that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public static com.liferay.portal.model.PortletItem updatePortletItem(
220                    com.liferay.portal.model.PortletItem portletItem)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return getService().updatePortletItem(portletItem);
223            }
224    
225            /**
226            * Updates the portlet item in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
227            *
228            * @param portletItem the portlet item
229            * @param merge whether to merge the portlet item 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.
230            * @return the portlet item that was updated
231            * @throws SystemException if a system exception occurred
232            */
233            public static com.liferay.portal.model.PortletItem updatePortletItem(
234                    com.liferay.portal.model.PortletItem portletItem, boolean merge)
235                    throws com.liferay.portal.kernel.exception.SystemException {
236                    return getService().updatePortletItem(portletItem, merge);
237            }
238    
239            /**
240            * Returns the Spring bean ID for this bean.
241            *
242            * @return the Spring bean ID for this bean
243            */
244            public static java.lang.String getBeanIdentifier() {
245                    return getService().getBeanIdentifier();
246            }
247    
248            /**
249            * Sets the Spring bean ID for this bean.
250            *
251            * @param beanIdentifier the Spring bean ID for this bean
252            */
253            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
254                    getService().setBeanIdentifier(beanIdentifier);
255            }
256    
257            public static com.liferay.portal.model.PortletItem addPortletItem(
258                    long userId, long groupId, java.lang.String name,
259                    java.lang.String portletId, java.lang.String className)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException {
262                    return getService()
263                                       .addPortletItem(userId, groupId, name, portletId, className);
264            }
265    
266            public static com.liferay.portal.model.PortletItem getPortletItem(
267                    long groupId, java.lang.String name, java.lang.String portletId,
268                    java.lang.String className)
269                    throws com.liferay.portal.kernel.exception.PortalException,
270                            com.liferay.portal.kernel.exception.SystemException {
271                    return getService().getPortletItem(groupId, name, portletId, className);
272            }
273    
274            public static java.util.List<com.liferay.portal.model.PortletItem> getPortletItems(
275                    long groupId, java.lang.String className)
276                    throws com.liferay.portal.kernel.exception.SystemException {
277                    return getService().getPortletItems(groupId, className);
278            }
279    
280            public static java.util.List<com.liferay.portal.model.PortletItem> getPortletItems(
281                    long groupId, java.lang.String portletId, java.lang.String className)
282                    throws com.liferay.portal.kernel.exception.SystemException {
283                    return getService().getPortletItems(groupId, portletId, className);
284            }
285    
286            public static com.liferay.portal.model.PortletItem updatePortletItem(
287                    long userId, long groupId, java.lang.String name,
288                    java.lang.String portletId, java.lang.String className)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException {
291                    return getService()
292                                       .updatePortletItem(userId, groupId, name, portletId,
293                            className);
294            }
295    
296            public static PortletItemLocalService getService() {
297                    if (_service == null) {
298                            _service = (PortletItemLocalService)PortalBeanLocatorUtil.locate(PortletItemLocalService.class.getName());
299    
300                            ReferenceRegistry.registerReference(PortletItemLocalServiceUtil.class,
301                                    "_service");
302                            MethodCache.remove(PortletItemLocalService.class);
303                    }
304    
305                    return _service;
306            }
307    
308            public void setService(PortletItemLocalService service) {
309                    MethodCache.remove(PortletItemLocalService.class);
310    
311                    _service = service;
312    
313                    ReferenceRegistry.registerReference(PortletItemLocalServiceUtil.class,
314                            "_service");
315                    MethodCache.remove(PortletItemLocalService.class);
316            }
317    
318            private static PortletItemLocalService _service;
319    }