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     * The interface for the password policy local service.
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 PasswordPolicyLocalServiceUtil
032     * @see com.liferay.portal.service.base.PasswordPolicyLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.PasswordPolicyLocalServiceImpl
034     * @generated
035     */
036    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
037            PortalException.class, SystemException.class})
038    public interface PasswordPolicyLocalService extends BaseLocalService,
039            PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * 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.
044             */
045    
046            /**
047            * Adds the password policy to the database. Also notifies the appropriate model listeners.
048            *
049            * @param passwordPolicy the password policy
050            * @return the password policy that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portal.model.PasswordPolicy addPasswordPolicy(
054                    com.liferay.portal.model.PasswordPolicy passwordPolicy)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new password policy with the primary key. Does not add the password policy to the database.
059            *
060            * @param passwordPolicyId the primary key for the new password policy
061            * @return the new password policy
062            */
063            public com.liferay.portal.model.PasswordPolicy createPasswordPolicy(
064                    long passwordPolicyId);
065    
066            /**
067            * Deletes the password policy with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param passwordPolicyId the primary key of the password policy
070            * @return the password policy that was removed
071            * @throws PortalException if a password policy with the primary key could not be found
072            * @throws SystemException if a system exception occurred
073            */
074            public com.liferay.portal.model.PasswordPolicy deletePasswordPolicy(
075                    long passwordPolicyId)
076                    throws com.liferay.portal.kernel.exception.PortalException,
077                            com.liferay.portal.kernel.exception.SystemException;
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 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    
092            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
093    
094            /**
095            * Performs a dynamic query on the database and returns the matching rows.
096            *
097            * @param dynamicQuery the dynamic query
098            * @return the matching rows
099            * @throws SystemException if a system exception occurred
100            */
101            @SuppressWarnings("rawtypes")
102            public java.util.List dynamicQuery(
103                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
104                    throws com.liferay.portal.kernel.exception.SystemException;
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 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    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException;
144    
145            /**
146            * Returns the number of rows that match the dynamic query.
147            *
148            * @param dynamicQuery the dynamic query
149            * @return the number of rows that match the dynamic query
150            * @throws SystemException if a system exception occurred
151            */
152            public long dynamicQueryCount(
153                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
154                    throws com.liferay.portal.kernel.exception.SystemException;
155    
156            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
157            public com.liferay.portal.model.PasswordPolicy fetchPasswordPolicy(
158                    long passwordPolicyId)
159                    throws com.liferay.portal.kernel.exception.SystemException;
160    
161            /**
162            * Returns the password policy with the primary key.
163            *
164            * @param passwordPolicyId the primary key of the password policy
165            * @return the password policy
166            * @throws PortalException if a password policy with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
171                    long passwordPolicyId)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException;
180    
181            /**
182            * Returns a range of all the password policies.
183            *
184            * <p>
185            * 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.
186            * </p>
187            *
188            * @param start the lower bound of the range of password policies
189            * @param end the upper bound of the range of password policies (not inclusive)
190            * @return the range of password policies
191            * @throws SystemException if a system exception occurred
192            */
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public java.util.List<com.liferay.portal.model.PasswordPolicy> getPasswordPolicies(
195                    int start, int end)
196                    throws com.liferay.portal.kernel.exception.SystemException;
197    
198            /**
199            * Returns the number of password policies.
200            *
201            * @return the number of password policies
202            * @throws SystemException if a system exception occurred
203            */
204            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
205            public int getPasswordPoliciesCount()
206                    throws com.liferay.portal.kernel.exception.SystemException;
207    
208            /**
209            * Updates the password policy in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
210            *
211            * @param passwordPolicy the password policy
212            * @return the password policy that was updated
213            * @throws SystemException if a system exception occurred
214            */
215            public com.liferay.portal.model.PasswordPolicy updatePasswordPolicy(
216                    com.liferay.portal.model.PasswordPolicy passwordPolicy)
217                    throws com.liferay.portal.kernel.exception.SystemException;
218    
219            /**
220            * Updates the password policy in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
221            *
222            * @param passwordPolicy the password policy
223            * @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.
224            * @return the password policy that was updated
225            * @throws SystemException if a system exception occurred
226            */
227            public com.liferay.portal.model.PasswordPolicy updatePasswordPolicy(
228                    com.liferay.portal.model.PasswordPolicy passwordPolicy, boolean merge)
229                    throws com.liferay.portal.kernel.exception.SystemException;
230    
231            /**
232            * Returns the Spring bean ID for this bean.
233            *
234            * @return the Spring bean ID for this bean
235            */
236            public java.lang.String getBeanIdentifier();
237    
238            /**
239            * Sets the Spring bean ID for this bean.
240            *
241            * @param beanIdentifier the Spring bean ID for this bean
242            */
243            public void setBeanIdentifier(java.lang.String beanIdentifier);
244    
245            public com.liferay.portal.model.PasswordPolicy addPasswordPolicy(
246                    long userId, boolean defaultPolicy, java.lang.String name,
247                    java.lang.String description, boolean changeable,
248                    boolean changeRequired, long minAge, boolean checkSyntax,
249                    boolean allowDictionaryWords, int minAlphanumeric, int minLength,
250                    int minLowerCase, int minNumbers, int minSymbols, int minUpperCase,
251                    boolean history, int historyCount, boolean expireable, long maxAge,
252                    long warningTime, int graceLimit, boolean lockout, int maxFailure,
253                    long lockoutDuration, long resetFailureCount, long resetTicketMaxAge)
254                    throws com.liferay.portal.kernel.exception.PortalException,
255                            com.liferay.portal.kernel.exception.SystemException;
256    
257            public void checkDefaultPasswordPolicy(long companyId)
258                    throws com.liferay.portal.kernel.exception.PortalException,
259                            com.liferay.portal.kernel.exception.SystemException;
260    
261            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
262            public com.liferay.portal.model.PasswordPolicy getDefaultPasswordPolicy(
263                    long companyId)
264                    throws com.liferay.portal.kernel.exception.PortalException,
265                            com.liferay.portal.kernel.exception.SystemException;
266    
267            /**
268            * @deprecated
269            */
270            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
271            public com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
272                    long companyId, long organizationId, long locationId)
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException;
275    
276            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
277            public com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
278                    long companyId, long[] organizationIds)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException;
281    
282            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
283            public com.liferay.portal.model.PasswordPolicy getPasswordPolicyByUserId(
284                    long userId)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
289            public java.util.List<com.liferay.portal.model.PasswordPolicy> search(
290                    long companyId, java.lang.String name, int start, int end,
291                    com.liferay.portal.kernel.util.OrderByComparator obc)
292                    throws com.liferay.portal.kernel.exception.SystemException;
293    
294            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
295            public int searchCount(long companyId, java.lang.String name)
296                    throws com.liferay.portal.kernel.exception.SystemException;
297    
298            public 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    }