001 /** 002 * Copyright (c) 2000-present 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.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.search.IndexableType; 022 import com.liferay.portal.kernel.transaction.Isolation; 023 import com.liferay.portal.kernel.transaction.Propagation; 024 import com.liferay.portal.kernel.transaction.Transactional; 025 026 /** 027 * Provides the local service interface for UserIdMapper. Methods of this 028 * service will not have security checks based on the propagated JAAS 029 * credentials because this service can only be accessed from within the same 030 * VM. 031 * 032 * @author Brian Wing Shun Chan 033 * @see UserIdMapperLocalServiceUtil 034 * @see com.liferay.portal.service.base.UserIdMapperLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.UserIdMapperLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface UserIdMapperLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * Never modify or reference this interface directly. Always use {@link UserIdMapperLocalServiceUtil} to access the user ID mapper local service. Add custom service methods to {@link com.liferay.portal.service.impl.UserIdMapperLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 047 */ 048 049 /** 050 * Adds the user ID mapper to the database. Also notifies the appropriate model listeners. 051 * 052 * @param userIdMapper the user ID mapper 053 * @return the user ID mapper that was added 054 */ 055 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 056 public com.liferay.portal.model.UserIdMapper addUserIdMapper( 057 com.liferay.portal.model.UserIdMapper userIdMapper); 058 059 /** 060 * Creates a new user ID mapper with the primary key. Does not add the user ID mapper to the database. 061 * 062 * @param userIdMapperId the primary key for the new user ID mapper 063 * @return the new user ID mapper 064 */ 065 public com.liferay.portal.model.UserIdMapper createUserIdMapper( 066 long userIdMapperId); 067 068 /** 069 * @throws PortalException 070 */ 071 @Override 072 public com.liferay.portal.model.PersistedModel deletePersistedModel( 073 com.liferay.portal.model.PersistedModel persistedModel) 074 throws com.liferay.portal.kernel.exception.PortalException; 075 076 /** 077 * Deletes the user ID mapper from the database. Also notifies the appropriate model listeners. 078 * 079 * @param userIdMapper the user ID mapper 080 * @return the user ID mapper that was removed 081 */ 082 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 083 public com.liferay.portal.model.UserIdMapper deleteUserIdMapper( 084 com.liferay.portal.model.UserIdMapper userIdMapper); 085 086 /** 087 * Deletes the user ID mapper with the primary key from the database. Also notifies the appropriate model listeners. 088 * 089 * @param userIdMapperId the primary key of the user ID mapper 090 * @return the user ID mapper that was removed 091 * @throws PortalException if a user ID mapper with the primary key could not be found 092 */ 093 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 094 public com.liferay.portal.model.UserIdMapper deleteUserIdMapper( 095 long userIdMapperId) 096 throws com.liferay.portal.kernel.exception.PortalException; 097 098 public void deleteUserIdMappers(long userId); 099 100 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 101 102 /** 103 * Performs a dynamic query on the database and returns the matching rows. 104 * 105 * @param dynamicQuery the dynamic query 106 * @return the matching rows 107 */ 108 public <T> java.util.List<T> dynamicQuery( 109 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 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 */ 123 public <T> java.util.List<T> dynamicQuery( 124 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 125 int end); 126 127 /** 128 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 129 * 130 * <p> 131 * 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. 132 * </p> 133 * 134 * @param dynamicQuery the dynamic query 135 * @param start the lower bound of the range of model instances 136 * @param end the upper bound of the range of model instances (not inclusive) 137 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 138 * @return the ordered range of matching rows 139 */ 140 public <T> java.util.List<T> dynamicQuery( 141 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 142 int end, 143 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 144 145 /** 146 * Returns the number of rows matching the dynamic query. 147 * 148 * @param dynamicQuery the dynamic query 149 * @return the number of rows matching the dynamic query 150 */ 151 public long dynamicQueryCount( 152 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 153 154 /** 155 * Returns the number of rows matching the dynamic query. 156 * 157 * @param dynamicQuery the dynamic query 158 * @param projection the projection to apply to the query 159 * @return the number of rows matching the dynamic query 160 */ 161 public long dynamicQueryCount( 162 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 163 com.liferay.portal.kernel.dao.orm.Projection projection); 164 165 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 166 public com.liferay.portal.model.UserIdMapper fetchUserIdMapper( 167 long userIdMapperId); 168 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 171 172 /** 173 * Returns the Spring bean ID for this bean. 174 * 175 * @return the Spring bean ID for this bean 176 */ 177 public java.lang.String getBeanIdentifier(); 178 179 @Override 180 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 181 public com.liferay.portal.model.PersistedModel getPersistedModel( 182 java.io.Serializable primaryKeyObj) 183 throws com.liferay.portal.kernel.exception.PortalException; 184 185 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 186 public com.liferay.portal.model.UserIdMapper getUserIdMapper(long userId, 187 java.lang.String type) 188 throws com.liferay.portal.kernel.exception.PortalException; 189 190 /** 191 * Returns the user ID mapper with the primary key. 192 * 193 * @param userIdMapperId the primary key of the user ID mapper 194 * @return the user ID mapper 195 * @throws PortalException if a user ID mapper with the primary key could not be found 196 */ 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public com.liferay.portal.model.UserIdMapper getUserIdMapper( 199 long userIdMapperId) 200 throws com.liferay.portal.kernel.exception.PortalException; 201 202 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 203 public com.liferay.portal.model.UserIdMapper getUserIdMapperByExternalUserId( 204 java.lang.String type, java.lang.String externalUserId) 205 throws com.liferay.portal.kernel.exception.PortalException; 206 207 /** 208 * Returns a range of all the user ID mappers. 209 * 210 * <p> 211 * 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. 212 * </p> 213 * 214 * @param start the lower bound of the range of user ID mappers 215 * @param end the upper bound of the range of user ID mappers (not inclusive) 216 * @return the range of user ID mappers 217 */ 218 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 219 public java.util.List<com.liferay.portal.model.UserIdMapper> getUserIdMappers( 220 int start, int end); 221 222 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 223 public java.util.List<com.liferay.portal.model.UserIdMapper> getUserIdMappers( 224 long userId); 225 226 /** 227 * Returns the number of user ID mappers. 228 * 229 * @return the number of user ID mappers 230 */ 231 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 232 public int getUserIdMappersCount(); 233 234 /** 235 * Sets the Spring bean ID for this bean. 236 * 237 * @param beanIdentifier the Spring bean ID for this bean 238 */ 239 public void setBeanIdentifier(java.lang.String beanIdentifier); 240 241 public com.liferay.portal.model.UserIdMapper updateUserIdMapper( 242 long userId, java.lang.String type, java.lang.String description, 243 java.lang.String externalUserId); 244 245 /** 246 * Updates the user ID mapper in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 247 * 248 * @param userIdMapper the user ID mapper 249 * @return the user ID mapper that was updated 250 */ 251 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 252 public com.liferay.portal.model.UserIdMapper updateUserIdMapper( 253 com.liferay.portal.model.UserIdMapper userIdMapper); 254 }