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