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.
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.
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.
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            * Updates the password policy in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
241            *
242            * @param passwordPolicy the password policy
243            * @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.
244            * @return the password policy that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portal.model.PasswordPolicy updatePasswordPolicy(
248                    com.liferay.portal.model.PasswordPolicy passwordPolicy, boolean merge)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updatePasswordPolicy(passwordPolicy, merge);
251            }
252    
253            /**
254            * Returns the Spring bean ID for this bean.
255            *
256            * @return the Spring bean ID for this bean
257            */
258            public static java.lang.String getBeanIdentifier() {
259                    return getService().getBeanIdentifier();
260            }
261    
262            /**
263            * Sets the Spring bean ID for this bean.
264            *
265            * @param beanIdentifier the Spring bean ID for this bean
266            */
267            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
268                    getService().setBeanIdentifier(beanIdentifier);
269            }
270    
271            public static com.liferay.portal.model.PasswordPolicy addPasswordPolicy(
272                    long userId, boolean defaultPolicy, java.lang.String name,
273                    java.lang.String description, boolean changeable,
274                    boolean changeRequired, long minAge, boolean checkSyntax,
275                    boolean allowDictionaryWords, int minAlphanumeric, int minLength,
276                    int minLowerCase, int minNumbers, int minSymbols, int minUpperCase,
277                    boolean history, int historyCount, boolean expireable, long maxAge,
278                    long warningTime, int graceLimit, boolean lockout, int maxFailure,
279                    long lockoutDuration, long resetFailureCount, long resetTicketMaxAge)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException {
282                    return getService()
283                                       .addPasswordPolicy(userId, defaultPolicy, name, description,
284                            changeable, changeRequired, minAge, checkSyntax,
285                            allowDictionaryWords, minAlphanumeric, minLength, minLowerCase,
286                            minNumbers, minSymbols, minUpperCase, history, historyCount,
287                            expireable, maxAge, warningTime, graceLimit, lockout, maxFailure,
288                            lockoutDuration, resetFailureCount, resetTicketMaxAge);
289            }
290    
291            public static void checkDefaultPasswordPolicy(long companyId)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException {
294                    getService().checkDefaultPasswordPolicy(companyId);
295            }
296    
297            public static com.liferay.portal.model.PasswordPolicy getDefaultPasswordPolicy(
298                    long companyId)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException {
301                    return getService().getDefaultPasswordPolicy(companyId);
302            }
303    
304            /**
305            * @deprecated
306            */
307            public static com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
308                    long companyId, long organizationId, long locationId)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException {
311                    return getService()
312                                       .getPasswordPolicy(companyId, organizationId, locationId);
313            }
314    
315            public static com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
316                    long companyId, long[] organizationIds)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException {
319                    return getService().getPasswordPolicy(companyId, organizationIds);
320            }
321    
322            public static com.liferay.portal.model.PasswordPolicy getPasswordPolicyByUserId(
323                    long userId)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException {
326                    return getService().getPasswordPolicyByUserId(userId);
327            }
328    
329            public static java.util.List<com.liferay.portal.model.PasswordPolicy> search(
330                    long companyId, java.lang.String name, int start, int end,
331                    com.liferay.portal.kernel.util.OrderByComparator obc)
332                    throws com.liferay.portal.kernel.exception.SystemException {
333                    return getService().search(companyId, name, start, end, obc);
334            }
335    
336            public static int searchCount(long companyId, java.lang.String name)
337                    throws com.liferay.portal.kernel.exception.SystemException {
338                    return getService().searchCount(companyId, name);
339            }
340    
341            public static com.liferay.portal.model.PasswordPolicy updatePasswordPolicy(
342                    long passwordPolicyId, java.lang.String name,
343                    java.lang.String description, boolean changeable,
344                    boolean changeRequired, long minAge, boolean checkSyntax,
345                    boolean allowDictionaryWords, int minAlphanumeric, int minLength,
346                    int minLowerCase, int minNumbers, int minSymbols, int minUpperCase,
347                    boolean history, int historyCount, boolean expireable, long maxAge,
348                    long warningTime, int graceLimit, boolean lockout, int maxFailure,
349                    long lockoutDuration, long resetFailureCount, long resetTicketMaxAge)
350                    throws com.liferay.portal.kernel.exception.PortalException,
351                            com.liferay.portal.kernel.exception.SystemException {
352                    return getService()
353                                       .updatePasswordPolicy(passwordPolicyId, name, description,
354                            changeable, changeRequired, minAge, checkSyntax,
355                            allowDictionaryWords, minAlphanumeric, minLength, minLowerCase,
356                            minNumbers, minSymbols, minUpperCase, history, historyCount,
357                            expireable, maxAge, warningTime, graceLimit, lockout, maxFailure,
358                            lockoutDuration, resetFailureCount, resetTicketMaxAge);
359            }
360    
361            public static PasswordPolicyLocalService getService() {
362                    if (_service == null) {
363                            _service = (PasswordPolicyLocalService)PortalBeanLocatorUtil.locate(PasswordPolicyLocalService.class.getName());
364    
365                            ReferenceRegistry.registerReference(PasswordPolicyLocalServiceUtil.class,
366                                    "_service");
367                    }
368    
369                    return _service;
370            }
371    
372            /**
373             * @deprecated
374             */
375            public void setService(PasswordPolicyLocalService service) {
376            }
377    
378            private static PasswordPolicyLocalService _service;
379    }