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