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.transaction.Isolation;
022    import com.liferay.portal.kernel.transaction.Propagation;
023    import com.liferay.portal.kernel.transaction.Transactional;
024    
025    /**
026     * Provides the local service interface for PasswordPolicy. Methods of this
027     * service will not have security checks based on the propagated JAAS
028     * credentials because this service can only be accessed from within the same
029     * VM.
030     *
031     * @author Brian Wing Shun Chan
032     * @see PasswordPolicyLocalServiceUtil
033     * @see com.liferay.portal.service.base.PasswordPolicyLocalServiceBaseImpl
034     * @see com.liferay.portal.service.impl.PasswordPolicyLocalServiceImpl
035     * @generated
036     */
037    @ProviderType
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface PasswordPolicyLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * Never modify or reference this interface directly. Always use {@link PasswordPolicyLocalServiceUtil} to access the password policy local service. Add custom service methods to {@link com.liferay.portal.service.impl.PasswordPolicyLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
046             */
047    
048            /**
049            * Adds the password policy to the database. Also notifies the appropriate model listeners.
050            *
051            * @param passwordPolicy the password policy
052            * @return the password policy that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portal.model.PasswordPolicy addPasswordPolicy(
056                    com.liferay.portal.model.PasswordPolicy passwordPolicy)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new password policy with the primary key. Does not add the password policy to the database.
061            *
062            * @param passwordPolicyId the primary key for the new password policy
063            * @return the new password policy
064            */
065            public com.liferay.portal.model.PasswordPolicy createPasswordPolicy(
066                    long passwordPolicyId);
067    
068            /**
069            * Deletes the password policy with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param passwordPolicyId the primary key of the password policy
072            * @return the password policy that was removed
073            * @throws PortalException if a password policy with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public com.liferay.portal.model.PasswordPolicy deletePasswordPolicy(
077                    long passwordPolicyId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            /**
082            * Deletes the password policy from the database. Also notifies the appropriate model listeners.
083            *
084            * @param passwordPolicy the password policy
085            * @return the password policy that was removed
086            * @throws PortalException
087            * @throws SystemException if a system exception occurred
088            */
089            public com.liferay.portal.model.PasswordPolicy deletePasswordPolicy(
090                    com.liferay.portal.model.PasswordPolicy passwordPolicy)
091                    throws com.liferay.portal.kernel.exception.PortalException,
092                            com.liferay.portal.kernel.exception.SystemException;
093    
094            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
095    
096            /**
097            * Performs a dynamic query on the database and returns the matching rows.
098            *
099            * @param dynamicQuery the dynamic query
100            * @return the matching rows
101            * @throws SystemException if a system exception occurred
102            */
103            @SuppressWarnings("rawtypes")
104            public java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException;
107    
108            /**
109            * Performs a dynamic query on the database and returns a range of the matching rows.
110            *
111            * <p>
112            * 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.PasswordPolicyModelImpl}. 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.
113            * </p>
114            *
115            * @param dynamicQuery the dynamic query
116            * @param start the lower bound of the range of model instances
117            * @param end the upper bound of the range of model instances (not inclusive)
118            * @return the range of matching rows
119            * @throws SystemException if a system exception occurred
120            */
121            @SuppressWarnings("rawtypes")
122            public java.util.List dynamicQuery(
123                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
124                    int end) throws com.liferay.portal.kernel.exception.SystemException;
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.PasswordPolicyModelImpl}. 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            * @throws SystemException if a system exception occurred
139            */
140            @SuppressWarnings("rawtypes")
141            public java.util.List dynamicQuery(
142                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
143                    int end,
144                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
145                    throws com.liferay.portal.kernel.exception.SystemException;
146    
147            /**
148            * Returns the number of rows that match the dynamic query.
149            *
150            * @param dynamicQuery the dynamic query
151            * @return the number of rows that match the dynamic query
152            * @throws SystemException if a system exception occurred
153            */
154            public long dynamicQueryCount(
155                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
156                    throws com.liferay.portal.kernel.exception.SystemException;
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @param projection the projection to apply to the query
163            * @return the number of rows that match the dynamic query
164            * @throws SystemException if a system exception occurred
165            */
166            public long dynamicQueryCount(
167                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
168                    com.liferay.portal.kernel.dao.orm.Projection projection)
169                    throws com.liferay.portal.kernel.exception.SystemException;
170    
171            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172            public com.liferay.portal.model.PasswordPolicy fetchPasswordPolicy(
173                    long passwordPolicyId)
174                    throws com.liferay.portal.kernel.exception.SystemException;
175    
176            /**
177            * Returns the password policy with the matching UUID and company.
178            *
179            * @param uuid the password policy's UUID
180            * @param companyId the primary key of the company
181            * @return the matching password policy, or <code>null</code> if a matching password policy could not be found
182            * @throws SystemException if a system exception occurred
183            */
184            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185            public com.liferay.portal.model.PasswordPolicy fetchPasswordPolicyByUuidAndCompanyId(
186                    java.lang.String uuid, long companyId)
187                    throws com.liferay.portal.kernel.exception.SystemException;
188    
189            /**
190            * Returns the password policy with the primary key.
191            *
192            * @param passwordPolicyId the primary key of the password policy
193            * @return the password policy
194            * @throws PortalException if a password policy with the primary key could not be found
195            * @throws SystemException if a system exception occurred
196            */
197            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
198            public com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
199                    long passwordPolicyId)
200                    throws com.liferay.portal.kernel.exception.PortalException,
201                            com.liferay.portal.kernel.exception.SystemException;
202    
203            @Override
204            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
205            public com.liferay.portal.model.PersistedModel getPersistedModel(
206                    java.io.Serializable primaryKeyObj)
207                    throws com.liferay.portal.kernel.exception.PortalException,
208                            com.liferay.portal.kernel.exception.SystemException;
209    
210            /**
211            * Returns the password policy with the matching UUID and company.
212            *
213            * @param uuid the password policy's UUID
214            * @param companyId the primary key of the company
215            * @return the matching password policy
216            * @throws PortalException if a matching password policy could not be found
217            * @throws SystemException if a system exception occurred
218            */
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public com.liferay.portal.model.PasswordPolicy getPasswordPolicyByUuidAndCompanyId(
221                    java.lang.String uuid, long companyId)
222                    throws com.liferay.portal.kernel.exception.PortalException,
223                            com.liferay.portal.kernel.exception.SystemException;
224    
225            /**
226            * Returns a range of all the password policies.
227            *
228            * <p>
229            * 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.PasswordPolicyModelImpl}. 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.
230            * </p>
231            *
232            * @param start the lower bound of the range of password policies
233            * @param end the upper bound of the range of password policies (not inclusive)
234            * @return the range of password policies
235            * @throws SystemException if a system exception occurred
236            */
237            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
238            public java.util.List<com.liferay.portal.model.PasswordPolicy> getPasswordPolicies(
239                    int start, int end)
240                    throws com.liferay.portal.kernel.exception.SystemException;
241    
242            /**
243            * Returns the number of password policies.
244            *
245            * @return the number of password policies
246            * @throws SystemException if a system exception occurred
247            */
248            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
249            public int getPasswordPoliciesCount()
250                    throws com.liferay.portal.kernel.exception.SystemException;
251    
252            /**
253            * Updates the password policy in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
254            *
255            * @param passwordPolicy the password policy
256            * @return the password policy that was updated
257            * @throws SystemException if a system exception occurred
258            */
259            public com.liferay.portal.model.PasswordPolicy updatePasswordPolicy(
260                    com.liferay.portal.model.PasswordPolicy passwordPolicy)
261                    throws com.liferay.portal.kernel.exception.SystemException;
262    
263            /**
264            * Returns the Spring bean ID for this bean.
265            *
266            * @return the Spring bean ID for this bean
267            */
268            public java.lang.String getBeanIdentifier();
269    
270            /**
271            * Sets the Spring bean ID for this bean.
272            *
273            * @param beanIdentifier the Spring bean ID for this bean
274            */
275            public void setBeanIdentifier(java.lang.String beanIdentifier);
276    
277            /**
278            * @deprecated As of 6.2.0, replaced by {@link #addPasswordPolicy(long,
279            boolean, String, String, boolean, boolean, long, boolean,
280            boolean, int, int, int, int, int, int, String, boolean, int,
281            boolean, long, long, int, boolean, int, long, long, long,
282            ServiceContext)}
283            */
284            public com.liferay.portal.model.PasswordPolicy addPasswordPolicy(
285                    long userId, boolean defaultPolicy, java.lang.String name,
286                    java.lang.String description, boolean changeable,
287                    boolean changeRequired, long minAge, boolean checkSyntax,
288                    boolean allowDictionaryWords, int minAlphanumeric, int minLength,
289                    int minLowerCase, int minNumbers, int minSymbols, int minUpperCase,
290                    boolean history, int historyCount, boolean expireable, long maxAge,
291                    long warningTime, int graceLimit, boolean lockout, int maxFailure,
292                    long lockoutDuration, long resetFailureCount, long resetTicketMaxAge)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException;
295    
296            public com.liferay.portal.model.PasswordPolicy addPasswordPolicy(
297                    long userId, boolean defaultPolicy, java.lang.String name,
298                    java.lang.String description, boolean changeable,
299                    boolean changeRequired, long minAge, boolean checkSyntax,
300                    boolean allowDictionaryWords, int minAlphanumeric, int minLength,
301                    int minLowerCase, int minNumbers, int minSymbols, int minUpperCase,
302                    java.lang.String regex, boolean history, int historyCount,
303                    boolean expireable, long maxAge, long warningTime, int graceLimit,
304                    boolean lockout, int maxFailure, long lockoutDuration,
305                    long resetFailureCount, long resetTicketMaxAge,
306                    com.liferay.portal.service.ServiceContext serviceContext)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException;
309    
310            public void checkDefaultPasswordPolicy(long companyId)
311                    throws com.liferay.portal.kernel.exception.PortalException,
312                            com.liferay.portal.kernel.exception.SystemException;
313    
314            public void deleteNondefaultPasswordPolicies(long companyId)
315                    throws com.liferay.portal.kernel.exception.PortalException,
316                            com.liferay.portal.kernel.exception.SystemException;
317    
318            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
319            public com.liferay.portal.model.PasswordPolicy fetchPasswordPolicy(
320                    long companyId, java.lang.String name)
321                    throws com.liferay.portal.kernel.exception.SystemException;
322    
323            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
324            public com.liferay.portal.model.PasswordPolicy getDefaultPasswordPolicy(
325                    long companyId)
326                    throws com.liferay.portal.kernel.exception.PortalException,
327                            com.liferay.portal.kernel.exception.SystemException;
328    
329            /**
330            * @deprecated As of 6.1.0
331            */
332            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
333            public com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
334                    long companyId, long organizationId, long locationId)
335                    throws com.liferay.portal.kernel.exception.PortalException,
336                            com.liferay.portal.kernel.exception.SystemException;
337    
338            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
339            public com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
340                    long companyId, long[] organizationIds)
341                    throws com.liferay.portal.kernel.exception.PortalException,
342                            com.liferay.portal.kernel.exception.SystemException;
343    
344            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
345            public com.liferay.portal.model.PasswordPolicy getPasswordPolicyByUserId(
346                    long userId)
347                    throws com.liferay.portal.kernel.exception.PortalException,
348                            com.liferay.portal.kernel.exception.SystemException;
349    
350            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
351            public java.util.List<com.liferay.portal.model.PasswordPolicy> search(
352                    long companyId, java.lang.String name, int start, int end,
353                    com.liferay.portal.kernel.util.OrderByComparator obc)
354                    throws com.liferay.portal.kernel.exception.SystemException;
355    
356            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
357            public int searchCount(long companyId, java.lang.String name)
358                    throws com.liferay.portal.kernel.exception.SystemException;
359    
360            /**
361            * @deprecated As of 6.2.0, replaced by {@link #updatePasswordPolicy(long,
362            String, String, boolean, boolean, long, boolean, boolean,
363            int, int, int, int, int, int, String, boolean, int, boolean,
364            long, long, int, boolean, int, long, long, long,
365            ServiceContext)}
366            */
367            public com.liferay.portal.model.PasswordPolicy updatePasswordPolicy(
368                    long passwordPolicyId, java.lang.String name,
369                    java.lang.String description, boolean changeable,
370                    boolean changeRequired, long minAge, boolean checkSyntax,
371                    boolean allowDictionaryWords, int minAlphanumeric, int minLength,
372                    int minLowerCase, int minNumbers, int minSymbols, int minUpperCase,
373                    boolean history, int historyCount, boolean expireable, long maxAge,
374                    long warningTime, int graceLimit, boolean lockout, int maxFailure,
375                    long lockoutDuration, long resetFailureCount, long resetTicketMaxAge)
376                    throws com.liferay.portal.kernel.exception.PortalException,
377                            com.liferay.portal.kernel.exception.SystemException;
378    
379            public com.liferay.portal.model.PasswordPolicy updatePasswordPolicy(
380                    long passwordPolicyId, java.lang.String name,
381                    java.lang.String description, boolean changeable,
382                    boolean changeRequired, long minAge, boolean checkSyntax,
383                    boolean allowDictionaryWords, int minAlphanumeric, int minLength,
384                    int minLowerCase, int minNumbers, int minSymbols, int minUpperCase,
385                    java.lang.String regex, boolean history, int historyCount,
386                    boolean expireable, long maxAge, long warningTime, int graceLimit,
387                    boolean lockout, int maxFailure, long lockoutDuration,
388                    long resetFailureCount, long resetTicketMaxAge,
389                    com.liferay.portal.service.ServiceContext serviceContext)
390                    throws com.liferay.portal.kernel.exception.PortalException,
391                            com.liferay.portal.kernel.exception.SystemException;
392    }