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.dao.orm.ActionableDynamicQuery;
020    import com.liferay.portal.kernel.dao.orm.DynamicQuery;
021    import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
022    import com.liferay.portal.kernel.dao.orm.Projection;
023    import com.liferay.portal.kernel.exception.PortalException;
024    import com.liferay.portal.kernel.exception.SystemException;
025    import com.liferay.portal.kernel.search.Indexable;
026    import com.liferay.portal.kernel.search.IndexableType;
027    import com.liferay.portal.kernel.transaction.Isolation;
028    import com.liferay.portal.kernel.transaction.Propagation;
029    import com.liferay.portal.kernel.transaction.Transactional;
030    import com.liferay.portal.kernel.util.OrderByComparator;
031    import com.liferay.portal.model.PasswordTracker;
032    import com.liferay.portal.model.PersistedModel;
033    
034    import java.io.Serializable;
035    
036    import java.util.List;
037    
038    /**
039     * Provides the local service interface for PasswordTracker. Methods of this
040     * service will not have security checks based on the propagated JAAS
041     * credentials because this service can only be accessed from within the same
042     * VM.
043     *
044     * @author Brian Wing Shun Chan
045     * @see PasswordTrackerLocalServiceUtil
046     * @see com.liferay.portal.service.base.PasswordTrackerLocalServiceBaseImpl
047     * @see com.liferay.portal.service.impl.PasswordTrackerLocalServiceImpl
048     * @generated
049     */
050    @ProviderType
051    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
052            PortalException.class, SystemException.class})
053    public interface PasswordTrackerLocalService extends BaseLocalService,
054            PersistedModelLocalService {
055            /*
056             * NOTE FOR DEVELOPERS:
057             *
058             * 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.
059             */
060    
061            /**
062            * Adds the password tracker to the database. Also notifies the appropriate model listeners.
063            *
064            * @param passwordTracker the password tracker
065            * @return the password tracker that was added
066            */
067            @Indexable(type = IndexableType.REINDEX)
068            public PasswordTracker addPasswordTracker(PasswordTracker passwordTracker);
069    
070            /**
071            * Creates a new password tracker with the primary key. Does not add the password tracker to the database.
072            *
073            * @param passwordTrackerId the primary key for the new password tracker
074            * @return the new password tracker
075            */
076            public PasswordTracker createPasswordTracker(long passwordTrackerId);
077    
078            /**
079            * Deletes the password tracker from the database. Also notifies the appropriate model listeners.
080            *
081            * @param passwordTracker the password tracker
082            * @return the password tracker that was removed
083            */
084            @Indexable(type = IndexableType.DELETE)
085            public PasswordTracker deletePasswordTracker(
086                    PasswordTracker passwordTracker);
087    
088            /**
089            * Deletes the password tracker with the primary key from the database. Also notifies the appropriate model listeners.
090            *
091            * @param passwordTrackerId the primary key of the password tracker
092            * @return the password tracker that was removed
093            * @throws PortalException if a password tracker with the primary key could not be found
094            */
095            @Indexable(type = IndexableType.DELETE)
096            public PasswordTracker deletePasswordTracker(long passwordTrackerId)
097                    throws PortalException;
098    
099            public void deletePasswordTrackers(long userId);
100    
101            /**
102            * @throws PortalException
103            */
104            @Override
105            public PersistedModel deletePersistedModel(PersistedModel persistedModel)
106                    throws PortalException;
107    
108            public DynamicQuery dynamicQuery();
109    
110            /**
111            * Performs a dynamic query on the database and returns the matching rows.
112            *
113            * @param dynamicQuery the dynamic query
114            * @return the matching rows
115            */
116            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery);
117    
118            /**
119            * Performs a dynamic query on the database and returns a range of the matching rows.
120            *
121            * <p>
122            * 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.
123            * </p>
124            *
125            * @param dynamicQuery the dynamic query
126            * @param start the lower bound of the range of model instances
127            * @param end the upper bound of the range of model instances (not inclusive)
128            * @return the range of matching rows
129            */
130            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
131                    int end);
132    
133            /**
134            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
135            *
136            * <p>
137            * 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.
138            * </p>
139            *
140            * @param dynamicQuery the dynamic query
141            * @param start the lower bound of the range of model instances
142            * @param end the upper bound of the range of model instances (not inclusive)
143            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
144            * @return the ordered range of matching rows
145            */
146            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
147                    int end, OrderByComparator<T> orderByComparator);
148    
149            /**
150            * Returns the number of rows matching the dynamic query.
151            *
152            * @param dynamicQuery the dynamic query
153            * @return the number of rows matching the dynamic query
154            */
155            public long dynamicQueryCount(DynamicQuery dynamicQuery);
156    
157            /**
158            * Returns the number of rows matching the dynamic query.
159            *
160            * @param dynamicQuery the dynamic query
161            * @param projection the projection to apply to the query
162            * @return the number of rows matching the dynamic query
163            */
164            public long dynamicQueryCount(DynamicQuery dynamicQuery,
165                    Projection projection);
166    
167            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
168            public PasswordTracker fetchPasswordTracker(long passwordTrackerId);
169    
170            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171            public ActionableDynamicQuery getActionableDynamicQuery();
172    
173            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174            public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
175    
176            /**
177            * Returns the OSGi service identifier.
178            *
179            * @return the OSGi service identifier
180            */
181            public java.lang.String getOSGiServiceIdentifier();
182    
183            /**
184            * Returns the password tracker with the primary key.
185            *
186            * @param passwordTrackerId the primary key of the password tracker
187            * @return the password tracker
188            * @throws PortalException if a password tracker with the primary key could not be found
189            */
190            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
191            public PasswordTracker getPasswordTracker(long passwordTrackerId)
192                    throws PortalException;
193    
194            /**
195            * Returns a range of all the password trackers.
196            *
197            * <p>
198            * 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.
199            * </p>
200            *
201            * @param start the lower bound of the range of password trackers
202            * @param end the upper bound of the range of password trackers (not inclusive)
203            * @return the range of password trackers
204            */
205            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
206            public List<PasswordTracker> getPasswordTrackers(int start, int end);
207    
208            /**
209            * Returns the number of password trackers.
210            *
211            * @return the number of password trackers
212            */
213            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
214            public int getPasswordTrackersCount();
215    
216            @Override
217            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218            public PersistedModel getPersistedModel(Serializable primaryKeyObj)
219                    throws PortalException;
220    
221            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
222            public boolean isSameAsCurrentPassword(long userId,
223                    java.lang.String newClearTextPwd) throws PortalException;
224    
225            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
226            public boolean isValidPassword(long userId, java.lang.String newClearTextPwd)
227                    throws PortalException;
228    
229            public void trackPassword(long userId, java.lang.String encPassword)
230                    throws PortalException;
231    
232            /**
233            * Updates the password tracker in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
234            *
235            * @param passwordTracker the password tracker
236            * @return the password tracker that was updated
237            */
238            @Indexable(type = IndexableType.REINDEX)
239            public PasswordTracker updatePasswordTracker(
240                    PasswordTracker passwordTracker);
241    }