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.annotation.Isolation;
018    import com.liferay.portal.kernel.annotation.Propagation;
019    import com.liferay.portal.kernel.annotation.Transactional;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.exception.SystemException;
022    
023    /**
024     * The interface for the password policy local service.
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * <p>
031     * 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.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see PasswordPolicyLocalServiceUtil
036     * @see com.liferay.portal.service.base.PasswordPolicyLocalServiceBaseImpl
037     * @see com.liferay.portal.service.impl.PasswordPolicyLocalServiceImpl
038     * @generated
039     */
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface PasswordPolicyLocalService {
043            /**
044            * Adds the password policy to the database. Also notifies the appropriate model listeners.
045            *
046            * @param passwordPolicy the password policy to add
047            * @return the password policy that was added
048            * @throws SystemException if a system exception occurred
049            */
050            public com.liferay.portal.model.PasswordPolicy addPasswordPolicy(
051                    com.liferay.portal.model.PasswordPolicy passwordPolicy)
052                    throws com.liferay.portal.kernel.exception.SystemException;
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 com.liferay.portal.model.PasswordPolicy createPasswordPolicy(
061                    long passwordPolicyId);
062    
063            /**
064            * Deletes the password policy with the primary key from the database. Also notifies the appropriate model listeners.
065            *
066            * @param passwordPolicyId the primary key of the password policy to delete
067            * @throws PortalException if a password policy with the primary key could not be found
068            * @throws SystemException if a system exception occurred
069            */
070            public void deletePasswordPolicy(long passwordPolicyId)
071                    throws com.liferay.portal.kernel.exception.PortalException,
072                            com.liferay.portal.kernel.exception.SystemException;
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 void deletePasswordPolicy(
081                    com.liferay.portal.model.PasswordPolicy passwordPolicy)
082                    throws com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Performs a dynamic query on the database and returns the matching rows.
086            *
087            * @param dynamicQuery the dynamic query to search with
088            * @return the matching rows
089            * @throws SystemException if a system exception occurred
090            */
091            @SuppressWarnings("rawtypes")
092            public java.util.List dynamicQuery(
093                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            /**
097            * Performs a dynamic query on the database and returns a range of the matching rows.
098            *
099            * <p>
100            * 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.
101            * </p>
102            *
103            * @param dynamicQuery the dynamic query to search with
104            * @param start the lower bound of the range of model instances to return
105            * @param end the upper bound of the range of model instances to return (not inclusive)
106            * @return the range of matching rows
107            * @throws SystemException if a system exception occurred
108            */
109            @SuppressWarnings("rawtypes")
110            public java.util.List dynamicQuery(
111                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
112                    int end) throws com.liferay.portal.kernel.exception.SystemException;
113    
114            /**
115            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
116            *
117            * <p>
118            * 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query to search with
122            * @param start the lower bound of the range of model instances to return
123            * @param end the upper bound of the range of model instances to return (not inclusive)
124            * @param orderByComparator the comparator to order the results by
125            * @return the ordered range of matching rows
126            * @throws SystemException if a system exception occurred
127            */
128            @SuppressWarnings("rawtypes")
129            public java.util.List dynamicQuery(
130                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
131                    int end,
132                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
133                    throws com.liferay.portal.kernel.exception.SystemException;
134    
135            /**
136            * Counts the number of rows that match the dynamic query.
137            *
138            * @param dynamicQuery the dynamic query to search with
139            * @return the number of rows that match the dynamic query
140            * @throws SystemException if a system exception occurred
141            */
142            public long dynamicQueryCount(
143                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
144                    throws com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Gets the password policy with the primary key.
148            *
149            * @param passwordPolicyId the primary key of the password policy to get
150            * @return the password policy
151            * @throws PortalException if a password policy with the primary key could not be found
152            * @throws SystemException if a system exception occurred
153            */
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
156                    long passwordPolicyId)
157                    throws com.liferay.portal.kernel.exception.PortalException,
158                            com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Gets a range of all the password policies.
162            *
163            * <p>
164            * 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.
165            * </p>
166            *
167            * @param start the lower bound of the range of password policies to return
168            * @param end the upper bound of the range of password policies to return (not inclusive)
169            * @return the range of password policies
170            * @throws SystemException if a system exception occurred
171            */
172            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
173            public java.util.List<com.liferay.portal.model.PasswordPolicy> getPasswordPolicies(
174                    int start, int end)
175                    throws com.liferay.portal.kernel.exception.SystemException;
176    
177            /**
178            * Gets the number of password policies.
179            *
180            * @return the number of password policies
181            * @throws SystemException if a system exception occurred
182            */
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public int getPasswordPoliciesCount()
185                    throws com.liferay.portal.kernel.exception.SystemException;
186    
187            /**
188            * Updates the password policy in the database. Also notifies the appropriate model listeners.
189            *
190            * @param passwordPolicy the password policy to update
191            * @return the password policy that was updated
192            * @throws SystemException if a system exception occurred
193            */
194            public com.liferay.portal.model.PasswordPolicy updatePasswordPolicy(
195                    com.liferay.portal.model.PasswordPolicy passwordPolicy)
196                    throws com.liferay.portal.kernel.exception.SystemException;
197    
198            /**
199            * Updates the password policy in the database. Also notifies the appropriate model listeners.
200            *
201            * @param passwordPolicy the password policy to update
202            * @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.
203            * @return the password policy that was updated
204            * @throws SystemException if a system exception occurred
205            */
206            public com.liferay.portal.model.PasswordPolicy updatePasswordPolicy(
207                    com.liferay.portal.model.PasswordPolicy passwordPolicy, boolean merge)
208                    throws com.liferay.portal.kernel.exception.SystemException;
209    
210            public com.liferay.portal.model.PasswordPolicy addPasswordPolicy(
211                    long userId, boolean defaultPolicy, java.lang.String name,
212                    java.lang.String description, boolean changeable,
213                    boolean changeRequired, long minAge, boolean checkSyntax,
214                    boolean allowDictionaryWords, int minAlphanumeric, int minLength,
215                    int minLowerCase, int minNumbers, int minSymbols, int minUpperCase,
216                    boolean history, int historyCount, boolean expireable, long maxAge,
217                    long warningTime, int graceLimit, boolean lockout, int maxFailure,
218                    long lockoutDuration, long resetFailureCount, long resetTicketMaxAge)
219                    throws com.liferay.portal.kernel.exception.PortalException,
220                            com.liferay.portal.kernel.exception.SystemException;
221    
222            public void checkDefaultPasswordPolicy(long companyId)
223                    throws com.liferay.portal.kernel.exception.PortalException,
224                            com.liferay.portal.kernel.exception.SystemException;
225    
226            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
227            public com.liferay.portal.model.PasswordPolicy getDefaultPasswordPolicy(
228                    long companyId)
229                    throws com.liferay.portal.kernel.exception.PortalException,
230                            com.liferay.portal.kernel.exception.SystemException;
231    
232            /**
233            * @deprecated
234            */
235            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
236            public com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
237                    long companyId, long organizationId, long locationId)
238                    throws com.liferay.portal.kernel.exception.PortalException,
239                            com.liferay.portal.kernel.exception.SystemException;
240    
241            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
242            public com.liferay.portal.model.PasswordPolicy getPasswordPolicy(
243                    long companyId, long[] organizationIds)
244                    throws com.liferay.portal.kernel.exception.PortalException,
245                            com.liferay.portal.kernel.exception.SystemException;
246    
247            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
248            public com.liferay.portal.model.PasswordPolicy getPasswordPolicyByUserId(
249                    long userId)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException;
252    
253            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
254            public java.util.List<com.liferay.portal.model.PasswordPolicy> search(
255                    long companyId, java.lang.String name, int start, int end,
256                    com.liferay.portal.kernel.util.OrderByComparator obc)
257                    throws com.liferay.portal.kernel.exception.SystemException;
258    
259            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
260            public int searchCount(long companyId, java.lang.String name)
261                    throws com.liferay.portal.kernel.exception.SystemException;
262    
263            public com.liferay.portal.model.PasswordPolicy updatePasswordPolicy(
264                    long passwordPolicyId, java.lang.String name,
265                    java.lang.String description, boolean changeable,
266                    boolean changeRequired, long minAge, boolean checkSyntax,
267                    boolean allowDictionaryWords, int minAlphanumeric, int minLength,
268                    int minLowerCase, int minNumbers, int minSymbols, int minUpperCase,
269                    boolean history, int historyCount, boolean expireable, long maxAge,
270                    long warningTime, int graceLimit, boolean lockout, int maxFailure,
271                    long lockoutDuration, long resetFailureCount, long resetTicketMaxAge)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException;
274    }