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