001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * 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.
021     *
022     * <p>
023     * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.PasswordPolicyLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
024     * </p>
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see PasswordPolicyLocalService
032     * @see com.liferay.portal.service.base.PasswordPolicyLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.PasswordPolicyLocalServiceImpl
034     * @generated
035     */
036    public class PasswordPolicyLocalServiceUtil {
037            /**
038            * Adds the password policy to the database. Also notifies the appropriate model listeners.
039            *
040            * @param passwordPolicy the password policy to add
041            * @return the password policy that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portal.model.PasswordPolicy addPasswordPolicy(
045                    com.liferay.portal.model.PasswordPolicy passwordPolicy)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addPasswordPolicy(passwordPolicy);
048            }
049    
050            /**
051            * Creates a new password policy with the primary key. Does not add the password policy to the database.
052            *
053            * @param passwordPolicyId the primary key for the new password policy
054            * @return the new password policy
055            */
056            public static com.liferay.portal.model.PasswordPolicy createPasswordPolicy(
057                    long passwordPolicyId) {
058                    return getService().createPasswordPolicy(passwordPolicyId);
059            }
060    
061            /**
062            * Deletes the password policy with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param passwordPolicyId the primary key of the password policy to delete
065            * @throws PortalException if a password policy with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deletePasswordPolicy(long passwordPolicyId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deletePasswordPolicy(passwordPolicyId);
072            }
073    
074            /**
075            * Deletes the password policy from the database. Also notifies the appropriate model listeners.
076            *
077            * @param passwordPolicy the password policy to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deletePasswordPolicy(
081                    com.liferay.portal.model.PasswordPolicy passwordPolicy)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deletePasswordPolicy(passwordPolicy);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * 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.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * 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.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the password policy with the primary key.
159            *
160            * @param passwordPolicyId the primary key of the password policy to get
161            * @return the password policy
162            * @throws PortalException if a password policy with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
166                    long passwordPolicyId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getPasswordPolicy(passwordPolicyId);
170            }
171    
172            /**
173            * Gets a range of all the password policies.
174            *
175            * <p>
176            * 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.
177            * </p>
178            *
179            * @param start the lower bound of the range of password policies to return
180            * @param end the upper bound of the range of password policies to return (not inclusive)
181            * @return the range of password policies
182            * @throws SystemException if a system exception occurred
183            */
184            public static java.util.List<com.liferay.portal.model.PasswordPolicy> getPasswordPolicies(
185                    int start, int end)
186                    throws com.liferay.portal.kernel.exception.SystemException {
187                    return getService().getPasswordPolicies(start, end);
188            }
189    
190            /**
191            * Gets the number of password policies.
192            *
193            * @return the number of password policies
194            * @throws SystemException if a system exception occurred
195            */
196            public static int getPasswordPoliciesCount()
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getPasswordPoliciesCount();
199            }
200    
201            /**
202            * Updates the password policy in the database. Also notifies the appropriate model listeners.
203            *
204            * @param passwordPolicy the password policy to update
205            * @return the password policy that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public static com.liferay.portal.model.PasswordPolicy updatePasswordPolicy(
209                    com.liferay.portal.model.PasswordPolicy passwordPolicy)
210                    throws com.liferay.portal.kernel.exception.SystemException {
211                    return getService().updatePasswordPolicy(passwordPolicy);
212            }
213    
214            /**
215            * Updates the password policy in the database. Also notifies the appropriate model listeners.
216            *
217            * @param passwordPolicy the password policy to update
218            * @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.
219            * @return the password policy that was updated
220            * @throws SystemException if a system exception occurred
221            */
222            public static com.liferay.portal.model.PasswordPolicy updatePasswordPolicy(
223                    com.liferay.portal.model.PasswordPolicy passwordPolicy, boolean merge)
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().updatePasswordPolicy(passwordPolicy, merge);
226            }
227    
228            public static com.liferay.portal.model.PasswordPolicy addPasswordPolicy(
229                    long userId, boolean defaultPolicy, java.lang.String name,
230                    java.lang.String description, boolean changeable,
231                    boolean changeRequired, long minAge, boolean checkSyntax,
232                    boolean allowDictionaryWords, int minAlphanumeric, int minLength,
233                    int minLowerCase, int minNumbers, int minSymbols, int minUpperCase,
234                    boolean history, int historyCount, boolean expireable, long maxAge,
235                    long warningTime, int graceLimit, boolean lockout, int maxFailure,
236                    long lockoutDuration, long resetFailureCount, long resetTicketMaxAge)
237                    throws com.liferay.portal.kernel.exception.PortalException,
238                            com.liferay.portal.kernel.exception.SystemException {
239                    return getService()
240                                       .addPasswordPolicy(userId, defaultPolicy, name, description,
241                            changeable, changeRequired, minAge, checkSyntax,
242                            allowDictionaryWords, minAlphanumeric, minLength, minLowerCase,
243                            minNumbers, minSymbols, minUpperCase, history, historyCount,
244                            expireable, maxAge, warningTime, graceLimit, lockout, maxFailure,
245                            lockoutDuration, resetFailureCount, resetTicketMaxAge);
246            }
247    
248            public static void checkDefaultPasswordPolicy(long companyId)
249                    throws com.liferay.portal.kernel.exception.PortalException,
250                            com.liferay.portal.kernel.exception.SystemException {
251                    getService().checkDefaultPasswordPolicy(companyId);
252            }
253    
254            public static com.liferay.portal.model.PasswordPolicy getDefaultPasswordPolicy(
255                    long companyId)
256                    throws com.liferay.portal.kernel.exception.PortalException,
257                            com.liferay.portal.kernel.exception.SystemException {
258                    return getService().getDefaultPasswordPolicy(companyId);
259            }
260    
261            /**
262            * @deprecated
263            */
264            public static com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
265                    long companyId, long organizationId, long locationId)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException {
268                    return getService()
269                                       .getPasswordPolicy(companyId, organizationId, locationId);
270            }
271    
272            public static com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
273                    long companyId, long[] organizationIds)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException {
276                    return getService().getPasswordPolicy(companyId, organizationIds);
277            }
278    
279            public static com.liferay.portal.model.PasswordPolicy getPasswordPolicyByUserId(
280                    long userId)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException {
283                    return getService().getPasswordPolicyByUserId(userId);
284            }
285    
286            public static java.util.List<com.liferay.portal.model.PasswordPolicy> search(
287                    long companyId, java.lang.String name, int start, int end,
288                    com.liferay.portal.kernel.util.OrderByComparator obc)
289                    throws com.liferay.portal.kernel.exception.SystemException {
290                    return getService().search(companyId, name, start, end, obc);
291            }
292    
293            public static int searchCount(long companyId, java.lang.String name)
294                    throws com.liferay.portal.kernel.exception.SystemException {
295                    return getService().searchCount(companyId, name);
296            }
297    
298            public static com.liferay.portal.model.PasswordPolicy updatePasswordPolicy(
299                    long passwordPolicyId, java.lang.String name,
300                    java.lang.String description, boolean changeable,
301                    boolean changeRequired, long minAge, boolean checkSyntax,
302                    boolean allowDictionaryWords, int minAlphanumeric, int minLength,
303                    int minLowerCase, int minNumbers, int minSymbols, int minUpperCase,
304                    boolean history, int historyCount, boolean expireable, long maxAge,
305                    long warningTime, int graceLimit, boolean lockout, int maxFailure,
306                    long lockoutDuration, long resetFailureCount, long resetTicketMaxAge)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException {
309                    return getService()
310                                       .updatePasswordPolicy(passwordPolicyId, name, description,
311                            changeable, changeRequired, minAge, checkSyntax,
312                            allowDictionaryWords, minAlphanumeric, minLength, minLowerCase,
313                            minNumbers, minSymbols, minUpperCase, history, historyCount,
314                            expireable, maxAge, warningTime, graceLimit, lockout, maxFailure,
315                            lockoutDuration, resetFailureCount, resetTicketMaxAge);
316            }
317    
318            public static PasswordPolicyLocalService getService() {
319                    if (_service == null) {
320                            _service = (PasswordPolicyLocalService)PortalBeanLocatorUtil.locate(PasswordPolicyLocalService.class.getName());
321                    }
322    
323                    return _service;
324            }
325    
326            public void setService(PasswordPolicyLocalService service) {
327                    _service = service;
328            }
329    
330            private static PasswordPolicyLocalService _service;
331    }