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 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 /** 160 * Returns the phone with the primary key. 161 * 162 * @param phoneId the primary key of the phone 163 * @return the phone 164 * @throws PortalException if a phone with the primary key could not be found 165 * @throws SystemException if a system exception occurred 166 */ 167 public static com.liferay.portal.model.Phone getPhone(long phoneId) 168 throws com.liferay.portal.kernel.exception.PortalException, 169 com.liferay.portal.kernel.exception.SystemException { 170 return getService().getPhone(phoneId); 171 } 172 173 public static com.liferay.portal.model.PersistedModel getPersistedModel( 174 java.io.Serializable primaryKeyObj) 175 throws com.liferay.portal.kernel.exception.PortalException, 176 com.liferay.portal.kernel.exception.SystemException { 177 return getService().getPersistedModel(primaryKeyObj); 178 } 179 180 /** 181 * Returns a range of all the phones. 182 * 183 * <p> 184 * 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. 185 * </p> 186 * 187 * @param start the lower bound of the range of phones 188 * @param end the upper bound of the range of phones (not inclusive) 189 * @return the range of phones 190 * @throws SystemException if a system exception occurred 191 */ 192 public static java.util.List<com.liferay.portal.model.Phone> getPhones( 193 int start, int end) 194 throws com.liferay.portal.kernel.exception.SystemException { 195 return getService().getPhones(start, end); 196 } 197 198 /** 199 * Returns the number of phones. 200 * 201 * @return the number of phones 202 * @throws SystemException if a system exception occurred 203 */ 204 public static int getPhonesCount() 205 throws com.liferay.portal.kernel.exception.SystemException { 206 return getService().getPhonesCount(); 207 } 208 209 /** 210 * Updates the phone in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 211 * 212 * @param phone the phone 213 * @return the phone that was updated 214 * @throws SystemException if a system exception occurred 215 */ 216 public static com.liferay.portal.model.Phone updatePhone( 217 com.liferay.portal.model.Phone phone) 218 throws com.liferay.portal.kernel.exception.SystemException { 219 return getService().updatePhone(phone); 220 } 221 222 /** 223 * Updates the phone in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 224 * 225 * @param phone the phone 226 * @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. 227 * @return the phone that was updated 228 * @throws SystemException if a system exception occurred 229 */ 230 public static com.liferay.portal.model.Phone updatePhone( 231 com.liferay.portal.model.Phone phone, boolean merge) 232 throws com.liferay.portal.kernel.exception.SystemException { 233 return getService().updatePhone(phone, merge); 234 } 235 236 /** 237 * Returns the Spring bean ID for this bean. 238 * 239 * @return the Spring bean ID for this bean 240 */ 241 public static java.lang.String getBeanIdentifier() { 242 return getService().getBeanIdentifier(); 243 } 244 245 /** 246 * Sets the Spring bean ID for this bean. 247 * 248 * @param beanIdentifier the Spring bean ID for this bean 249 */ 250 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 251 getService().setBeanIdentifier(beanIdentifier); 252 } 253 254 public static com.liferay.portal.model.Phone addPhone(long userId, 255 java.lang.String className, long classPK, java.lang.String number, 256 java.lang.String extension, int typeId, boolean primary) 257 throws com.liferay.portal.kernel.exception.PortalException, 258 com.liferay.portal.kernel.exception.SystemException { 259 return getService() 260 .addPhone(userId, className, classPK, number, extension, 261 typeId, primary); 262 } 263 264 public static void deletePhones(long companyId, java.lang.String className, 265 long classPK) 266 throws com.liferay.portal.kernel.exception.SystemException { 267 getService().deletePhones(companyId, className, classPK); 268 } 269 270 public static java.util.List<com.liferay.portal.model.Phone> getPhones() 271 throws com.liferay.portal.kernel.exception.SystemException { 272 return getService().getPhones(); 273 } 274 275 public static java.util.List<com.liferay.portal.model.Phone> getPhones( 276 long companyId, java.lang.String className, long classPK) 277 throws com.liferay.portal.kernel.exception.SystemException { 278 return getService().getPhones(companyId, className, classPK); 279 } 280 281 public static com.liferay.portal.model.Phone updatePhone(long phoneId, 282 java.lang.String number, java.lang.String extension, int typeId, 283 boolean primary) 284 throws com.liferay.portal.kernel.exception.PortalException, 285 com.liferay.portal.kernel.exception.SystemException { 286 return getService() 287 .updatePhone(phoneId, number, extension, typeId, primary); 288 } 289 290 public static PhoneLocalService getService() { 291 if (_service == null) { 292 _service = (PhoneLocalService)PortalBeanLocatorUtil.locate(PhoneLocalService.class.getName()); 293 294 ReferenceRegistry.registerReference(PhoneLocalServiceUtil.class, 295 "_service"); 296 MethodCache.remove(PhoneLocalService.class); 297 } 298 299 return _service; 300 } 301 302 public void setService(PhoneLocalService service) { 303 MethodCache.remove(PhoneLocalService.class); 304 305 _service = service; 306 307 ReferenceRegistry.registerReference(PhoneLocalServiceUtil.class, 308 "_service"); 309 MethodCache.remove(PhoneLocalService.class); 310 } 311 312 private static PhoneLocalService _service; 313 }