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