001    /**
002     * Copyright (c) 2000-2011 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.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * 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.
023     *
024     * <p>
025     * 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.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see PasswordPolicyLocalService
030     * @see com.liferay.portal.service.base.PasswordPolicyLocalServiceBaseImpl
031     * @see com.liferay.portal.service.impl.PasswordPolicyLocalServiceImpl
032     * @generated
033     */
034    public class PasswordPolicyLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.PasswordPolicyLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the password policy to the database. Also notifies the appropriate model listeners.
043            *
044            * @param passwordPolicy the password policy
045            * @return the password policy that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portal.model.PasswordPolicy addPasswordPolicy(
049                    com.liferay.portal.model.PasswordPolicy passwordPolicy)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addPasswordPolicy(passwordPolicy);
052            }
053    
054            /**
055            * Creates a new password policy with the primary key. Does not add the password policy to the database.
056            *
057            * @param passwordPolicyId the primary key for the new password policy
058            * @return the new password policy
059            */
060            public static com.liferay.portal.model.PasswordPolicy createPasswordPolicy(
061                    long passwordPolicyId) {
062                    return getService().createPasswordPolicy(passwordPolicyId);
063            }
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            * @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 void deletePasswordPolicy(long passwordPolicyId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deletePasswordPolicy(passwordPolicyId);
076            }
077    
078            /**
079            * Deletes the password policy from the database. Also notifies the appropriate model listeners.
080            *
081            * @param passwordPolicy the password policy
082            * @throws PortalException
083            * @throws SystemException if a system exception occurred
084            */
085            public static void deletePasswordPolicy(
086                    com.liferay.portal.model.PasswordPolicy passwordPolicy)
087                    throws com.liferay.portal.kernel.exception.PortalException,
088                            com.liferay.portal.kernel.exception.SystemException {
089                    getService().deletePasswordPolicy(passwordPolicy);
090            }
091    
092            /**
093            * Performs a dynamic query on the database and returns the matching rows.
094            *
095            * @param dynamicQuery the dynamic query
096            * @return the matching rows
097            * @throws SystemException if a system exception occurred
098            */
099            @SuppressWarnings("rawtypes")
100            public static java.util.List dynamicQuery(
101                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
102                    throws com.liferay.portal.kernel.exception.SystemException {
103                    return getService().dynamicQuery(dynamicQuery);
104            }
105    
106            /**
107            * Performs a dynamic query on the database and returns a range of the matching rows.
108            *
109            * <p>
110            * 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.
111            * </p>
112            *
113            * @param dynamicQuery the dynamic query
114            * @param start the lower bound of the range of model instances
115            * @param end the upper bound of the range of model instances (not inclusive)
116            * @return the range of matching rows
117            * @throws SystemException if a system exception occurred
118            */
119            @SuppressWarnings("rawtypes")
120            public static java.util.List dynamicQuery(
121                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
122                    int end) throws com.liferay.portal.kernel.exception.SystemException {
123                    return getService().dynamicQuery(dynamicQuery, start, end);
124            }
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.
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 static 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                    return getService()
147                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
148            }
149    
150            /**
151            * Returns the number of rows that match the dynamic query.
152            *
153            * @param dynamicQuery the dynamic query
154            * @return the number of rows that match the dynamic query
155            * @throws SystemException if a system exception occurred
156            */
157            public static long dynamicQueryCount(
158                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
159                    throws com.liferay.portal.kernel.exception.SystemException {
160                    return getService().dynamicQueryCount(dynamicQuery);
161            }
162    
163            /**
164            * Returns the password policy with the primary key.
165            *
166            * @param passwordPolicyId the primary key of the password policy
167            * @return the password policy
168            * @throws PortalException if a password policy with the primary key could not be found
169            * @throws SystemException if a system exception occurred
170            */
171            public static com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
172                    long passwordPolicyId)
173                    throws com.liferay.portal.kernel.exception.PortalException,
174                            com.liferay.portal.kernel.exception.SystemException {
175                    return getService().getPasswordPolicy(passwordPolicyId);
176            }
177    
178            public static com.liferay.portal.model.PersistedModel getPersistedModel(
179                    java.io.Serializable primaryKeyObj)
180                    throws com.liferay.portal.kernel.exception.PortalException,
181                            com.liferay.portal.kernel.exception.SystemException {
182                    return getService().getPersistedModel(primaryKeyObj);
183            }
184    
185            /**
186            * Returns a range of all the password policies.
187            *
188            * <p>
189            * 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.
190            * </p>
191            *
192            * @param start the lower bound of the range of password policies
193            * @param end the upper bound of the range of password policies (not inclusive)
194            * @return the range of password policies
195            * @throws SystemException if a system exception occurred
196            */
197            public static java.util.List<com.liferay.portal.model.PasswordPolicy> getPasswordPolicies(
198                    int start, int end)
199                    throws com.liferay.portal.kernel.exception.SystemException {
200                    return getService().getPasswordPolicies(start, end);
201            }
202    
203            /**
204            * Returns the number of password policies.
205            *
206            * @return the number of password policies
207            * @throws SystemException if a system exception occurred
208            */
209            public static int getPasswordPoliciesCount()
210                    throws com.liferay.portal.kernel.exception.SystemException {
211                    return getService().getPasswordPoliciesCount();
212            }
213    
214            /**
215            * Updates the password policy in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
216            *
217            * @param passwordPolicy the password policy
218            * @return the password policy that was updated
219            * @throws SystemException if a system exception occurred
220            */
221            public static com.liferay.portal.model.PasswordPolicy updatePasswordPolicy(
222                    com.liferay.portal.model.PasswordPolicy passwordPolicy)
223                    throws com.liferay.portal.kernel.exception.SystemException {
224                    return getService().updatePasswordPolicy(passwordPolicy);
225            }
226    
227            /**
228            * Updates the password policy in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
229            *
230            * @param passwordPolicy the password policy
231            * @param merge whether to merge the password policy with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
232            * @return the password policy that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public static com.liferay.portal.model.PasswordPolicy updatePasswordPolicy(
236                    com.liferay.portal.model.PasswordPolicy passwordPolicy, boolean merge)
237                    throws com.liferay.portal.kernel.exception.SystemException {
238                    return getService().updatePasswordPolicy(passwordPolicy, merge);
239            }
240    
241            /**
242            * Returns the Spring bean ID for this bean.
243            *
244            * @return the Spring bean ID for this bean
245            */
246            public static java.lang.String getBeanIdentifier() {
247                    return getService().getBeanIdentifier();
248            }
249    
250            /**
251            * Sets the Spring bean ID for this bean.
252            *
253            * @param beanIdentifier the Spring bean ID for this bean
254            */
255            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
256                    getService().setBeanIdentifier(beanIdentifier);
257            }
258    
259            public static com.liferay.portal.model.PasswordPolicy addPasswordPolicy(
260                    long userId, boolean defaultPolicy, java.lang.String name,
261                    java.lang.String description, boolean changeable,
262                    boolean changeRequired, long minAge, boolean checkSyntax,
263                    boolean allowDictionaryWords, int minAlphanumeric, int minLength,
264                    int minLowerCase, int minNumbers, int minSymbols, int minUpperCase,
265                    boolean history, int historyCount, boolean expireable, long maxAge,
266                    long warningTime, int graceLimit, boolean lockout, int maxFailure,
267                    long lockoutDuration, long resetFailureCount, long resetTicketMaxAge)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException {
270                    return getService()
271                                       .addPasswordPolicy(userId, defaultPolicy, name, description,
272                            changeable, changeRequired, minAge, checkSyntax,
273                            allowDictionaryWords, minAlphanumeric, minLength, minLowerCase,
274                            minNumbers, minSymbols, minUpperCase, history, historyCount,
275                            expireable, maxAge, warningTime, graceLimit, lockout, maxFailure,
276                            lockoutDuration, resetFailureCount, resetTicketMaxAge);
277            }
278    
279            public static void checkDefaultPasswordPolicy(long companyId)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException {
282                    getService().checkDefaultPasswordPolicy(companyId);
283            }
284    
285            public static com.liferay.portal.model.PasswordPolicy getDefaultPasswordPolicy(
286                    long companyId)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException {
289                    return getService().getDefaultPasswordPolicy(companyId);
290            }
291    
292            /**
293            * @deprecated
294            */
295            public static com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
296                    long companyId, long organizationId, long locationId)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException {
299                    return getService()
300                                       .getPasswordPolicy(companyId, organizationId, locationId);
301            }
302    
303            public static com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
304                    long companyId, long[] organizationIds)
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException {
307                    return getService().getPasswordPolicy(companyId, organizationIds);
308            }
309    
310            public static com.liferay.portal.model.PasswordPolicy getPasswordPolicyByUserId(
311                    long userId)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    return getService().getPasswordPolicyByUserId(userId);
315            }
316    
317            public static java.util.List<com.liferay.portal.model.PasswordPolicy> search(
318                    long companyId, java.lang.String name, int start, int end,
319                    com.liferay.portal.kernel.util.OrderByComparator obc)
320                    throws com.liferay.portal.kernel.exception.SystemException {
321                    return getService().search(companyId, name, start, end, obc);
322            }
323    
324            public static int searchCount(long companyId, java.lang.String name)
325                    throws com.liferay.portal.kernel.exception.SystemException {
326                    return getService().searchCount(companyId, name);
327            }
328    
329            public static com.liferay.portal.model.PasswordPolicy updatePasswordPolicy(
330                    long passwordPolicyId, java.lang.String name,
331                    java.lang.String description, boolean changeable,
332                    boolean changeRequired, long minAge, boolean checkSyntax,
333                    boolean allowDictionaryWords, int minAlphanumeric, int minLength,
334                    int minLowerCase, int minNumbers, int minSymbols, int minUpperCase,
335                    boolean history, int historyCount, boolean expireable, long maxAge,
336                    long warningTime, int graceLimit, boolean lockout, int maxFailure,
337                    long lockoutDuration, long resetFailureCount, long resetTicketMaxAge)
338                    throws com.liferay.portal.kernel.exception.PortalException,
339                            com.liferay.portal.kernel.exception.SystemException {
340                    return getService()
341                                       .updatePasswordPolicy(passwordPolicyId, name, description,
342                            changeable, changeRequired, minAge, checkSyntax,
343                            allowDictionaryWords, minAlphanumeric, minLength, minLowerCase,
344                            minNumbers, minSymbols, minUpperCase, history, historyCount,
345                            expireable, maxAge, warningTime, graceLimit, lockout, maxFailure,
346                            lockoutDuration, resetFailureCount, resetTicketMaxAge);
347            }
348    
349            public static PasswordPolicyLocalService getService() {
350                    if (_service == null) {
351                            _service = (PasswordPolicyLocalService)PortalBeanLocatorUtil.locate(PasswordPolicyLocalService.class.getName());
352    
353                            ReferenceRegistry.registerReference(PasswordPolicyLocalServiceUtil.class,
354                                    "_service");
355                            MethodCache.remove(PasswordPolicyLocalService.class);
356                    }
357    
358                    return _service;
359            }
360    
361            public void setService(PasswordPolicyLocalService service) {
362                    MethodCache.remove(PasswordPolicyLocalService.class);
363    
364                    _service = service;
365    
366                    ReferenceRegistry.registerReference(PasswordPolicyLocalServiceUtil.class,
367                            "_service");
368                    MethodCache.remove(PasswordPolicyLocalService.class);
369            }
370    
371            private static PasswordPolicyLocalService _service;
372    }