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 portal preferences local service. This utility wraps {@link com.liferay.portal.service.impl.PortalPreferencesLocalServiceImpl} 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 PortalPreferencesLocalService 030 * @see com.liferay.portal.service.base.PortalPreferencesLocalServiceBaseImpl 031 * @see com.liferay.portal.service.impl.PortalPreferencesLocalServiceImpl 032 * @generated 033 */ 034 public class PortalPreferencesLocalServiceUtil { 035 /* 036 * NOTE FOR DEVELOPERS: 037 * 038 * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.PortalPreferencesLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 039 */ 040 041 /** 042 * Adds the portal preferences to the database. Also notifies the appropriate model listeners. 043 * 044 * @param portalPreferences the portal preferences 045 * @return the portal preferences that was added 046 * @throws SystemException if a system exception occurred 047 */ 048 public static com.liferay.portal.model.PortalPreferences addPortalPreferences( 049 com.liferay.portal.model.PortalPreferences portalPreferences) 050 throws com.liferay.portal.kernel.exception.SystemException { 051 return getService().addPortalPreferences(portalPreferences); 052 } 053 054 /** 055 * Creates a new portal preferences with the primary key. Does not add the portal preferences to the database. 056 * 057 * @param portalPreferencesId the primary key for the new portal preferences 058 * @return the new portal preferences 059 */ 060 public static com.liferay.portal.model.PortalPreferences createPortalPreferences( 061 long portalPreferencesId) { 062 return getService().createPortalPreferences(portalPreferencesId); 063 } 064 065 /** 066 * Deletes the portal preferences with the primary key from the database. Also notifies the appropriate model listeners. 067 * 068 * @param portalPreferencesId the primary key of the portal preferences 069 * @throws PortalException if a portal preferences with the primary key could not be found 070 * @throws SystemException if a system exception occurred 071 */ 072 public static void deletePortalPreferences(long portalPreferencesId) 073 throws com.liferay.portal.kernel.exception.PortalException, 074 com.liferay.portal.kernel.exception.SystemException { 075 getService().deletePortalPreferences(portalPreferencesId); 076 } 077 078 /** 079 * Deletes the portal preferences from the database. Also notifies the appropriate model listeners. 080 * 081 * @param portalPreferences the portal preferences 082 * @throws SystemException if a system exception occurred 083 */ 084 public static void deletePortalPreferences( 085 com.liferay.portal.model.PortalPreferences portalPreferences) 086 throws com.liferay.portal.kernel.exception.SystemException { 087 getService().deletePortalPreferences(portalPreferences); 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 public static com.liferay.portal.model.PortalPreferences fetchPortalPreferences( 162 long portalPreferencesId) 163 throws com.liferay.portal.kernel.exception.SystemException { 164 return getService().fetchPortalPreferences(portalPreferencesId); 165 } 166 167 /** 168 * Returns the portal preferences with the primary key. 169 * 170 * @param portalPreferencesId the primary key of the portal preferences 171 * @return the portal preferences 172 * @throws PortalException if a portal preferences with the primary key could not be found 173 * @throws SystemException if a system exception occurred 174 */ 175 public static com.liferay.portal.model.PortalPreferences getPortalPreferences( 176 long portalPreferencesId) 177 throws com.liferay.portal.kernel.exception.PortalException, 178 com.liferay.portal.kernel.exception.SystemException { 179 return getService().getPortalPreferences(portalPreferencesId); 180 } 181 182 public static com.liferay.portal.model.PersistedModel getPersistedModel( 183 java.io.Serializable primaryKeyObj) 184 throws com.liferay.portal.kernel.exception.PortalException, 185 com.liferay.portal.kernel.exception.SystemException { 186 return getService().getPersistedModel(primaryKeyObj); 187 } 188 189 /** 190 * Returns a range of all the portal preferenceses. 191 * 192 * <p> 193 * 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. 194 * </p> 195 * 196 * @param start the lower bound of the range of portal preferenceses 197 * @param end the upper bound of the range of portal preferenceses (not inclusive) 198 * @return the range of portal preferenceses 199 * @throws SystemException if a system exception occurred 200 */ 201 public static java.util.List<com.liferay.portal.model.PortalPreferences> getPortalPreferenceses( 202 int start, int end) 203 throws com.liferay.portal.kernel.exception.SystemException { 204 return getService().getPortalPreferenceses(start, end); 205 } 206 207 /** 208 * Returns the number of portal preferenceses. 209 * 210 * @return the number of portal preferenceses 211 * @throws SystemException if a system exception occurred 212 */ 213 public static int getPortalPreferencesesCount() 214 throws com.liferay.portal.kernel.exception.SystemException { 215 return getService().getPortalPreferencesesCount(); 216 } 217 218 /** 219 * Updates the portal preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 220 * 221 * @param portalPreferences the portal preferences 222 * @return the portal preferences that was updated 223 * @throws SystemException if a system exception occurred 224 */ 225 public static com.liferay.portal.model.PortalPreferences updatePortalPreferences( 226 com.liferay.portal.model.PortalPreferences portalPreferences) 227 throws com.liferay.portal.kernel.exception.SystemException { 228 return getService().updatePortalPreferences(portalPreferences); 229 } 230 231 /** 232 * Updates the portal preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 233 * 234 * @param portalPreferences the portal preferences 235 * @param merge whether to merge the portal preferences 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. 236 * @return the portal preferences that was updated 237 * @throws SystemException if a system exception occurred 238 */ 239 public static com.liferay.portal.model.PortalPreferences updatePortalPreferences( 240 com.liferay.portal.model.PortalPreferences portalPreferences, 241 boolean merge) 242 throws com.liferay.portal.kernel.exception.SystemException { 243 return getService().updatePortalPreferences(portalPreferences, merge); 244 } 245 246 /** 247 * Returns the Spring bean ID for this bean. 248 * 249 * @return the Spring bean ID for this bean 250 */ 251 public static java.lang.String getBeanIdentifier() { 252 return getService().getBeanIdentifier(); 253 } 254 255 /** 256 * Sets the Spring bean ID for this bean. 257 * 258 * @param beanIdentifier the Spring bean ID for this bean 259 */ 260 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 261 getService().setBeanIdentifier(beanIdentifier); 262 } 263 264 public static com.liferay.portal.model.PortalPreferences addPortalPreferences( 265 long companyId, long ownerId, int ownerType, 266 java.lang.String defaultPreferences) 267 throws com.liferay.portal.kernel.exception.SystemException { 268 return getService() 269 .addPortalPreferences(companyId, ownerId, ownerType, 270 defaultPreferences); 271 } 272 273 public static javax.portlet.PortletPreferences getPreferences( 274 long companyId, long ownerId, int ownerType) 275 throws com.liferay.portal.kernel.exception.SystemException { 276 return getService().getPreferences(companyId, ownerId, ownerType); 277 } 278 279 public static javax.portlet.PortletPreferences getPreferences( 280 long companyId, long ownerId, int ownerType, 281 java.lang.String defaultPreferences) 282 throws com.liferay.portal.kernel.exception.SystemException { 283 return getService() 284 .getPreferences(companyId, ownerId, ownerType, 285 defaultPreferences); 286 } 287 288 public static com.liferay.portal.model.PortalPreferences updatePreferences( 289 long ownerId, int ownerType, 290 com.liferay.portlet.PortalPreferences portalPreferences) 291 throws com.liferay.portal.kernel.exception.SystemException { 292 return getService() 293 .updatePreferences(ownerId, ownerType, portalPreferences); 294 } 295 296 public static com.liferay.portal.model.PortalPreferences updatePreferences( 297 long ownerId, int ownerType, java.lang.String xml) 298 throws com.liferay.portal.kernel.exception.SystemException { 299 return getService().updatePreferences(ownerId, ownerType, xml); 300 } 301 302 public static PortalPreferencesLocalService getService() { 303 if (_service == null) { 304 _service = (PortalPreferencesLocalService)PortalBeanLocatorUtil.locate(PortalPreferencesLocalService.class.getName()); 305 306 ReferenceRegistry.registerReference(PortalPreferencesLocalServiceUtil.class, 307 "_service"); 308 MethodCache.remove(PortalPreferencesLocalService.class); 309 } 310 311 return _service; 312 } 313 314 public void setService(PortalPreferencesLocalService service) { 315 MethodCache.remove(PortalPreferencesLocalService.class); 316 317 _service = service; 318 319 ReferenceRegistry.registerReference(PortalPreferencesLocalServiceUtil.class, 320 "_service"); 321 MethodCache.remove(PortalPreferencesLocalService.class); 322 } 323 324 private static PortalPreferencesLocalService _service; 325 }