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