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