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 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) throws PortalException; 096 097 public void deleteUserIdMappers(long userId); 098 099 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 100 101 /** 102 * Performs a dynamic query on the database and returns the matching rows. 103 * 104 * @param dynamicQuery the dynamic query 105 * @return the matching rows 106 */ 107 public <T> java.util.List<T> dynamicQuery( 108 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 109 110 /** 111 * Performs a dynamic query on the database and returns a range of the matching rows. 112 * 113 * <p> 114 * 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. 115 * </p> 116 * 117 * @param dynamicQuery the dynamic query 118 * @param start the lower bound of the range of model instances 119 * @param end the upper bound of the range of model instances (not inclusive) 120 * @return the range of matching rows 121 */ 122 public <T> java.util.List<T> dynamicQuery( 123 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 124 int end); 125 126 /** 127 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 128 * 129 * <p> 130 * 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. 131 * </p> 132 * 133 * @param dynamicQuery the dynamic query 134 * @param start the lower bound of the range of model instances 135 * @param end the upper bound of the range of model instances (not inclusive) 136 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 137 * @return the ordered range of matching rows 138 */ 139 public <T> java.util.List<T> dynamicQuery( 140 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 141 int end, 142 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 143 144 /** 145 * Returns the number of rows matching the dynamic query. 146 * 147 * @param dynamicQuery the dynamic query 148 * @return the number of rows matching the dynamic query 149 */ 150 public long dynamicQueryCount( 151 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 152 153 /** 154 * Returns the number of rows matching the dynamic query. 155 * 156 * @param dynamicQuery the dynamic query 157 * @param projection the projection to apply to the query 158 * @return the number of rows matching the dynamic query 159 */ 160 public long dynamicQueryCount( 161 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 162 com.liferay.portal.kernel.dao.orm.Projection projection); 163 164 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 165 public com.liferay.portal.model.UserIdMapper fetchUserIdMapper( 166 long userIdMapperId); 167 168 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 169 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 170 171 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 172 public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 173 174 /** 175 * Returns the OSGi service identifier. 176 * 177 * @return the OSGi service identifier 178 */ 179 public java.lang.String getOSGiServiceIdentifier(); 180 181 @Override 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.portal.model.PersistedModel getPersistedModel( 184 java.io.Serializable primaryKeyObj) throws PortalException; 185 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public com.liferay.portal.model.UserIdMapper getUserIdMapper(long userId, 188 java.lang.String type) throws 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) throws PortalException; 200 201 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 202 public com.liferay.portal.model.UserIdMapper getUserIdMapperByExternalUserId( 203 java.lang.String type, java.lang.String externalUserId) 204 throws PortalException; 205 206 /** 207 * Returns a range of all the user ID mappers. 208 * 209 * <p> 210 * 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. 211 * </p> 212 * 213 * @param start the lower bound of the range of user ID mappers 214 * @param end the upper bound of the range of user ID mappers (not inclusive) 215 * @return the range of user ID mappers 216 */ 217 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 218 public java.util.List<com.liferay.portal.model.UserIdMapper> getUserIdMappers( 219 int start, int end); 220 221 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 222 public java.util.List<com.liferay.portal.model.UserIdMapper> getUserIdMappers( 223 long userId); 224 225 /** 226 * Returns the number of user ID mappers. 227 * 228 * @return the number of user ID mappers 229 */ 230 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 231 public int getUserIdMappersCount(); 232 233 public com.liferay.portal.model.UserIdMapper updateUserIdMapper( 234 long userId, java.lang.String type, java.lang.String description, 235 java.lang.String externalUserId); 236 237 /** 238 * Updates the user ID mapper in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 239 * 240 * @param userIdMapper the user ID mapper 241 * @return the user ID mapper that was updated 242 */ 243 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 244 public com.liferay.portal.model.UserIdMapper updateUserIdMapper( 245 com.liferay.portal.model.UserIdMapper userIdMapper); 246 }