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 PasswordTracker. 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 PasswordTrackerLocalServiceUtil 034 * @see com.liferay.portal.service.base.PasswordTrackerLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.PasswordTrackerLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface PasswordTrackerLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * Never modify or reference this interface directly. Always use {@link PasswordTrackerLocalServiceUtil} to access the password tracker local service. Add custom service methods to {@link com.liferay.portal.service.impl.PasswordTrackerLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 047 */ 048 049 /** 050 * Adds the password tracker to the database. Also notifies the appropriate model listeners. 051 * 052 * @param passwordTracker the password tracker 053 * @return the password tracker that was added 054 */ 055 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 056 public com.liferay.portal.model.PasswordTracker addPasswordTracker( 057 com.liferay.portal.model.PasswordTracker passwordTracker); 058 059 /** 060 * Creates a new password tracker with the primary key. Does not add the password tracker to the database. 061 * 062 * @param passwordTrackerId the primary key for the new password tracker 063 * @return the new password tracker 064 */ 065 public com.liferay.portal.model.PasswordTracker createPasswordTracker( 066 long passwordTrackerId); 067 068 /** 069 * Deletes the password tracker from the database. Also notifies the appropriate model listeners. 070 * 071 * @param passwordTracker the password tracker 072 * @return the password tracker that was removed 073 */ 074 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 075 public com.liferay.portal.model.PasswordTracker deletePasswordTracker( 076 com.liferay.portal.model.PasswordTracker passwordTracker); 077 078 /** 079 * Deletes the password tracker with the primary key from the database. Also notifies the appropriate model listeners. 080 * 081 * @param passwordTrackerId the primary key of the password tracker 082 * @return the password tracker that was removed 083 * @throws PortalException if a password tracker with the primary key could not be found 084 */ 085 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 086 public com.liferay.portal.model.PasswordTracker deletePasswordTracker( 087 long passwordTrackerId) 088 throws com.liferay.portal.kernel.exception.PortalException; 089 090 public void deletePasswordTrackers(long userId); 091 092 /** 093 * @throws PortalException 094 */ 095 @Override 096 public com.liferay.portal.model.PersistedModel deletePersistedModel( 097 com.liferay.portal.model.PersistedModel persistedModel) 098 throws com.liferay.portal.kernel.exception.PortalException; 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.PasswordTrackerModelImpl}. 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.PasswordTrackerModelImpl}. 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.PasswordTracker fetchPasswordTracker( 167 long passwordTrackerId); 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 /** 180 * Returns the password tracker with the primary key. 181 * 182 * @param passwordTrackerId the primary key of the password tracker 183 * @return the password tracker 184 * @throws PortalException if a password tracker with the primary key could not be found 185 */ 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public com.liferay.portal.model.PasswordTracker getPasswordTracker( 188 long passwordTrackerId) 189 throws com.liferay.portal.kernel.exception.PortalException; 190 191 /** 192 * Returns a range of all the password trackers. 193 * 194 * <p> 195 * 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.PasswordTrackerModelImpl}. 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. 196 * </p> 197 * 198 * @param start the lower bound of the range of password trackers 199 * @param end the upper bound of the range of password trackers (not inclusive) 200 * @return the range of password trackers 201 */ 202 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 203 public java.util.List<com.liferay.portal.model.PasswordTracker> getPasswordTrackers( 204 int start, int end); 205 206 /** 207 * Returns the number of password trackers. 208 * 209 * @return the number of password trackers 210 */ 211 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 212 public int getPasswordTrackersCount(); 213 214 @Override 215 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 216 public com.liferay.portal.model.PersistedModel getPersistedModel( 217 java.io.Serializable primaryKeyObj) 218 throws com.liferay.portal.kernel.exception.PortalException; 219 220 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 221 public boolean isSameAsCurrentPassword(long userId, 222 java.lang.String newClearTextPwd) 223 throws com.liferay.portal.kernel.exception.PortalException; 224 225 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 226 public boolean isValidPassword(long userId, java.lang.String newClearTextPwd) 227 throws com.liferay.portal.kernel.exception.PortalException; 228 229 /** 230 * Sets the Spring bean ID for this bean. 231 * 232 * @param beanIdentifier the Spring bean ID for this bean 233 */ 234 public void setBeanIdentifier(java.lang.String beanIdentifier); 235 236 public void trackPassword(long userId, java.lang.String encPassword) 237 throws com.liferay.portal.kernel.exception.PortalException; 238 239 /** 240 * Updates the password tracker in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 241 * 242 * @param passwordTracker the password tracker 243 * @return the password tracker that was updated 244 */ 245 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 246 public com.liferay.portal.model.PasswordTracker updatePasswordTracker( 247 com.liferay.portal.model.PasswordTracker passwordTracker); 248 }