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 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 * @throws SystemException if a system exception occurred 055 */ 056 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 057 public com.liferay.portal.model.PasswordTracker addPasswordTracker( 058 com.liferay.portal.model.PasswordTracker passwordTracker) 059 throws com.liferay.portal.kernel.exception.SystemException; 060 061 /** 062 * Creates a new password tracker with the primary key. Does not add the password tracker to the database. 063 * 064 * @param passwordTrackerId the primary key for the new password tracker 065 * @return the new password tracker 066 */ 067 public com.liferay.portal.model.PasswordTracker createPasswordTracker( 068 long passwordTrackerId); 069 070 /** 071 * Deletes the password tracker with the primary key from the database. Also notifies the appropriate model listeners. 072 * 073 * @param passwordTrackerId the primary key of the password tracker 074 * @return the password tracker that was removed 075 * @throws PortalException if a password tracker with the primary key could not be found 076 * @throws SystemException if a system exception occurred 077 */ 078 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 079 public com.liferay.portal.model.PasswordTracker deletePasswordTracker( 080 long passwordTrackerId) 081 throws com.liferay.portal.kernel.exception.PortalException, 082 com.liferay.portal.kernel.exception.SystemException; 083 084 /** 085 * Deletes the password tracker from the database. Also notifies the appropriate model listeners. 086 * 087 * @param passwordTracker the password tracker 088 * @return the password tracker that was removed 089 * @throws SystemException if a system exception occurred 090 */ 091 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 092 public com.liferay.portal.model.PasswordTracker deletePasswordTracker( 093 com.liferay.portal.model.PasswordTracker passwordTracker) 094 throws com.liferay.portal.kernel.exception.SystemException; 095 096 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 097 098 /** 099 * Performs a dynamic query on the database and returns the matching rows. 100 * 101 * @param dynamicQuery the dynamic query 102 * @return the matching rows 103 * @throws SystemException if a system exception occurred 104 */ 105 @SuppressWarnings("rawtypes") 106 public java.util.List dynamicQuery( 107 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 108 throws com.liferay.portal.kernel.exception.SystemException; 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.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. 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 * @throws SystemException if a system exception occurred 122 */ 123 @SuppressWarnings("rawtypes") 124 public java.util.List dynamicQuery( 125 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 126 int end) throws com.liferay.portal.kernel.exception.SystemException; 127 128 /** 129 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 130 * 131 * <p> 132 * 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. 133 * </p> 134 * 135 * @param dynamicQuery the dynamic query 136 * @param start the lower bound of the range of model instances 137 * @param end the upper bound of the range of model instances (not inclusive) 138 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 139 * @return the ordered range of matching rows 140 * @throws SystemException if a system exception occurred 141 */ 142 @SuppressWarnings("rawtypes") 143 public java.util.List dynamicQuery( 144 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 145 int end, 146 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 147 throws com.liferay.portal.kernel.exception.SystemException; 148 149 /** 150 * Returns the number of rows that match the dynamic query. 151 * 152 * @param dynamicQuery the dynamic query 153 * @return the number of rows that match the dynamic query 154 * @throws SystemException if a system exception occurred 155 */ 156 public long dynamicQueryCount( 157 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 158 throws com.liferay.portal.kernel.exception.SystemException; 159 160 /** 161 * Returns the number of rows that match the dynamic query. 162 * 163 * @param dynamicQuery the dynamic query 164 * @param projection the projection to apply to the query 165 * @return the number of rows that match the dynamic query 166 * @throws SystemException if a system exception occurred 167 */ 168 public long dynamicQueryCount( 169 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 170 com.liferay.portal.kernel.dao.orm.Projection projection) 171 throws com.liferay.portal.kernel.exception.SystemException; 172 173 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 174 public com.liferay.portal.model.PasswordTracker fetchPasswordTracker( 175 long passwordTrackerId) 176 throws com.liferay.portal.kernel.exception.SystemException; 177 178 /** 179 * Returns the password tracker with the primary key. 180 * 181 * @param passwordTrackerId the primary key of the password tracker 182 * @return the password tracker 183 * @throws PortalException if a password tracker with the primary key could not be found 184 * @throws SystemException if a system exception occurred 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 com.liferay.portal.kernel.exception.SystemException; 191 192 @Override 193 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 194 public com.liferay.portal.model.PersistedModel getPersistedModel( 195 java.io.Serializable primaryKeyObj) 196 throws com.liferay.portal.kernel.exception.PortalException, 197 com.liferay.portal.kernel.exception.SystemException; 198 199 /** 200 * Returns a range of all the password trackers. 201 * 202 * <p> 203 * 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. 204 * </p> 205 * 206 * @param start the lower bound of the range of password trackers 207 * @param end the upper bound of the range of password trackers (not inclusive) 208 * @return the range of password trackers 209 * @throws SystemException if a system exception occurred 210 */ 211 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 212 public java.util.List<com.liferay.portal.model.PasswordTracker> getPasswordTrackers( 213 int start, int end) 214 throws com.liferay.portal.kernel.exception.SystemException; 215 216 /** 217 * Returns the number of password trackers. 218 * 219 * @return the number of password trackers 220 * @throws SystemException if a system exception occurred 221 */ 222 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 223 public int getPasswordTrackersCount() 224 throws com.liferay.portal.kernel.exception.SystemException; 225 226 /** 227 * Updates the password tracker in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 228 * 229 * @param passwordTracker the password tracker 230 * @return the password tracker that was updated 231 * @throws SystemException if a system exception occurred 232 */ 233 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 234 public com.liferay.portal.model.PasswordTracker updatePasswordTracker( 235 com.liferay.portal.model.PasswordTracker passwordTracker) 236 throws com.liferay.portal.kernel.exception.SystemException; 237 238 /** 239 * Returns the Spring bean ID for this bean. 240 * 241 * @return the Spring bean ID for this bean 242 */ 243 public java.lang.String getBeanIdentifier(); 244 245 /** 246 * Sets the Spring bean ID for this bean. 247 * 248 * @param beanIdentifier the Spring bean ID for this bean 249 */ 250 public void setBeanIdentifier(java.lang.String beanIdentifier); 251 252 public void deletePasswordTrackers(long userId) 253 throws com.liferay.portal.kernel.exception.SystemException; 254 255 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 256 public boolean isSameAsCurrentPassword(long userId, 257 java.lang.String newClearTextPwd) 258 throws com.liferay.portal.kernel.exception.PortalException, 259 com.liferay.portal.kernel.exception.SystemException; 260 261 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 262 public boolean isValidPassword(long userId, java.lang.String newClearTextPwd) 263 throws com.liferay.portal.kernel.exception.PortalException, 264 com.liferay.portal.kernel.exception.SystemException; 265 266 public void trackPassword(long userId, java.lang.String encPassword) 267 throws com.liferay.portal.kernel.exception.PortalException, 268 com.liferay.portal.kernel.exception.SystemException; 269 }