001 /** 002 * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 013 */ 014 015 package com.liferay.portal.service; 016 017 import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; 018 019 /** 020 * The utility for the user id mapper local service. This utility wraps {@link com.liferay.portal.service.impl.UserIdMapperLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server. 021 * 022 * <p> 023 * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.UserIdMapperLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 024 * </p> 025 * 026 * <p> 027 * 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. 028 * </p> 029 * 030 * @author Brian Wing Shun Chan 031 * @see UserIdMapperLocalService 032 * @see com.liferay.portal.service.base.UserIdMapperLocalServiceBaseImpl 033 * @see com.liferay.portal.service.impl.UserIdMapperLocalServiceImpl 034 * @generated 035 */ 036 public class UserIdMapperLocalServiceUtil { 037 /** 038 * Adds the user id mapper to the database. Also notifies the appropriate model listeners. 039 * 040 * @param userIdMapper the user id mapper to add 041 * @return the user id mapper that was added 042 * @throws SystemException if a system exception occurred 043 */ 044 public static com.liferay.portal.model.UserIdMapper addUserIdMapper( 045 com.liferay.portal.model.UserIdMapper userIdMapper) 046 throws com.liferay.portal.kernel.exception.SystemException { 047 return getService().addUserIdMapper(userIdMapper); 048 } 049 050 /** 051 * Creates a new user id mapper with the primary key. Does not add the user id mapper to the database. 052 * 053 * @param userIdMapperId the primary key for the new user id mapper 054 * @return the new user id mapper 055 */ 056 public static com.liferay.portal.model.UserIdMapper createUserIdMapper( 057 long userIdMapperId) { 058 return getService().createUserIdMapper(userIdMapperId); 059 } 060 061 /** 062 * Deletes the user id mapper with the primary key from the database. Also notifies the appropriate model listeners. 063 * 064 * @param userIdMapperId the primary key of the user id mapper to delete 065 * @throws PortalException if a user id mapper with the primary key could not be found 066 * @throws SystemException if a system exception occurred 067 */ 068 public static void deleteUserIdMapper(long userIdMapperId) 069 throws com.liferay.portal.kernel.exception.PortalException, 070 com.liferay.portal.kernel.exception.SystemException { 071 getService().deleteUserIdMapper(userIdMapperId); 072 } 073 074 /** 075 * Deletes the user id mapper from the database. Also notifies the appropriate model listeners. 076 * 077 * @param userIdMapper the user id mapper to delete 078 * @throws SystemException if a system exception occurred 079 */ 080 public static void deleteUserIdMapper( 081 com.liferay.portal.model.UserIdMapper userIdMapper) 082 throws com.liferay.portal.kernel.exception.SystemException { 083 getService().deleteUserIdMapper(userIdMapper); 084 } 085 086 /** 087 * Performs a dynamic query on the database and returns the matching rows. 088 * 089 * @param dynamicQuery the dynamic query to search with 090 * @return the matching rows 091 * @throws SystemException if a system exception occurred 092 */ 093 @SuppressWarnings("rawtypes") 094 public static java.util.List dynamicQuery( 095 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 096 throws com.liferay.portal.kernel.exception.SystemException { 097 return getService().dynamicQuery(dynamicQuery); 098 } 099 100 /** 101 * Performs a dynamic query on the database and returns a range of the matching rows. 102 * 103 * <p> 104 * 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. 105 * </p> 106 * 107 * @param dynamicQuery the dynamic query to search with 108 * @param start the lower bound of the range of model instances to return 109 * @param end the upper bound of the range of model instances to return (not inclusive) 110 * @return the range of matching rows 111 * @throws SystemException if a system exception occurred 112 */ 113 @SuppressWarnings("rawtypes") 114 public static java.util.List dynamicQuery( 115 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 116 int end) throws com.liferay.portal.kernel.exception.SystemException { 117 return getService().dynamicQuery(dynamicQuery, start, end); 118 } 119 120 /** 121 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 122 * 123 * <p> 124 * 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. 125 * </p> 126 * 127 * @param dynamicQuery the dynamic query to search with 128 * @param start the lower bound of the range of model instances to return 129 * @param end the upper bound of the range of model instances to return (not inclusive) 130 * @param orderByComparator the comparator to order the results by 131 * @return the ordered range of matching rows 132 * @throws SystemException if a system exception occurred 133 */ 134 @SuppressWarnings("rawtypes") 135 public static java.util.List dynamicQuery( 136 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 137 int end, 138 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 139 throws com.liferay.portal.kernel.exception.SystemException { 140 return getService() 141 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 142 } 143 144 /** 145 * Counts the number of rows that match the dynamic query. 146 * 147 * @param dynamicQuery the dynamic query to search with 148 * @return the number of rows that match the dynamic query 149 * @throws SystemException if a system exception occurred 150 */ 151 public static long dynamicQueryCount( 152 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 153 throws com.liferay.portal.kernel.exception.SystemException { 154 return getService().dynamicQueryCount(dynamicQuery); 155 } 156 157 /** 158 * Gets the user id mapper with the primary key. 159 * 160 * @param userIdMapperId the primary key of the user id mapper to get 161 * @return the user id mapper 162 * @throws PortalException if a user id mapper with the primary key could not be found 163 * @throws SystemException if a system exception occurred 164 */ 165 public static com.liferay.portal.model.UserIdMapper getUserIdMapper( 166 long userIdMapperId) 167 throws com.liferay.portal.kernel.exception.PortalException, 168 com.liferay.portal.kernel.exception.SystemException { 169 return getService().getUserIdMapper(userIdMapperId); 170 } 171 172 /** 173 * Gets a range of all the user id mappers. 174 * 175 * <p> 176 * 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. 177 * </p> 178 * 179 * @param start the lower bound of the range of user id mappers to return 180 * @param end the upper bound of the range of user id mappers to return (not inclusive) 181 * @return the range of user id mappers 182 * @throws SystemException if a system exception occurred 183 */ 184 public static java.util.List<com.liferay.portal.model.UserIdMapper> getUserIdMappers( 185 int start, int end) 186 throws com.liferay.portal.kernel.exception.SystemException { 187 return getService().getUserIdMappers(start, end); 188 } 189 190 /** 191 * Gets the number of user id mappers. 192 * 193 * @return the number of user id mappers 194 * @throws SystemException if a system exception occurred 195 */ 196 public static int getUserIdMappersCount() 197 throws com.liferay.portal.kernel.exception.SystemException { 198 return getService().getUserIdMappersCount(); 199 } 200 201 /** 202 * Updates the user id mapper in the database. Also notifies the appropriate model listeners. 203 * 204 * @param userIdMapper the user id mapper to update 205 * @return the user id mapper that was updated 206 * @throws SystemException if a system exception occurred 207 */ 208 public static com.liferay.portal.model.UserIdMapper updateUserIdMapper( 209 com.liferay.portal.model.UserIdMapper userIdMapper) 210 throws com.liferay.portal.kernel.exception.SystemException { 211 return getService().updateUserIdMapper(userIdMapper); 212 } 213 214 /** 215 * Updates the user id mapper in the database. Also notifies the appropriate model listeners. 216 * 217 * @param userIdMapper the user id mapper to update 218 * @param merge whether to merge the user id mapper 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. 219 * @return the user id mapper that was updated 220 * @throws SystemException if a system exception occurred 221 */ 222 public static com.liferay.portal.model.UserIdMapper updateUserIdMapper( 223 com.liferay.portal.model.UserIdMapper userIdMapper, boolean merge) 224 throws com.liferay.portal.kernel.exception.SystemException { 225 return getService().updateUserIdMapper(userIdMapper, merge); 226 } 227 228 public static void deleteUserIdMappers(long userId) 229 throws com.liferay.portal.kernel.exception.SystemException { 230 getService().deleteUserIdMappers(userId); 231 } 232 233 public static com.liferay.portal.model.UserIdMapper getUserIdMapper( 234 long userId, java.lang.String type) 235 throws com.liferay.portal.kernel.exception.PortalException, 236 com.liferay.portal.kernel.exception.SystemException { 237 return getService().getUserIdMapper(userId, type); 238 } 239 240 public static com.liferay.portal.model.UserIdMapper getUserIdMapperByExternalUserId( 241 java.lang.String type, java.lang.String externalUserId) 242 throws com.liferay.portal.kernel.exception.PortalException, 243 com.liferay.portal.kernel.exception.SystemException { 244 return getService().getUserIdMapperByExternalUserId(type, externalUserId); 245 } 246 247 public static java.util.List<com.liferay.portal.model.UserIdMapper> getUserIdMappers( 248 long userId) throws com.liferay.portal.kernel.exception.SystemException { 249 return getService().getUserIdMappers(userId); 250 } 251 252 public static com.liferay.portal.model.UserIdMapper updateUserIdMapper( 253 long userId, java.lang.String type, java.lang.String description, 254 java.lang.String externalUserId) 255 throws com.liferay.portal.kernel.exception.SystemException { 256 return getService() 257 .updateUserIdMapper(userId, type, description, externalUserId); 258 } 259 260 public static UserIdMapperLocalService getService() { 261 if (_service == null) { 262 _service = (UserIdMapperLocalService)PortalBeanLocatorUtil.locate(UserIdMapperLocalService.class.getName()); 263 } 264 265 return _service; 266 } 267 268 public void setService(UserIdMapperLocalService service) { 269 _service = service; 270 } 271 272 private static UserIdMapperLocalService _service; 273 }