I_CmsValidationHandler


1   /*
2    * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/security/I_CmsValidationHandler.java,v $
3    * Date   : $Date: 2006/05/12 16:05:48 $
4    * Version: $Revision: 1.2 $
5    *
6    * This library is part of OpenCms -
7    * the Open Source Content Mananagement System
8    *
9    * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10   *
11   * This library is free software; you can redistribute it and/or
12   * modify it under the terms of the GNU Lesser General Public
13   * License as published by the Free Software Foundation; either
14   * version 2.1 of the License, or (at your option) any later version.
15   *
16   * This library is distributed in the hope that it will be useful,
17   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   * Lesser General Public License for more details.
20   *
21   * For further information about Alkacon Software GmbH, please see the
22   * company website: http://www.alkacon.com
23   *
24   * For further information about OpenCms, please see the
25   * project website: http://www.opencms.org
26   * 
27   * You should have received a copy of the GNU Lesser General Public
28   * License along with this library; if not, write to the Free Software
29   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30   */
31  
32  package org.opencms.security;
33  
34  import org.opencms.main.CmsIllegalArgumentException;
35  
36  /**
37   * Defines general validation methods.<p>
38   * 
39   * @author Michael Moossen
40   *
41   * @version $Revision: 1.2 $ 
42   * 
43   * @since 6.3.0 
44   */
45  public interface I_CmsValidationHandler {
46  
47      /**
48       * Checks if the provided email is a valid email address.<p>
49       * 
50       * @param email the email address to validate
51       * 
52       * @throws CmsIllegalArgumentException if the given email address is not valid
53       */
54      void checkEmail(String   email) throws CmsIllegalArgumentException;
55  
56      /**
57       * Checks if the provided group name is a valid user name.<p>
58       *
59       * @param groupName the group name to check
60       * 
61       * @throws CmsIllegalArgumentException if the given group name is not valid
62       */
63      void checkGroupName(String   groupName) throws CmsIllegalArgumentException;
64  
65      /**
66       * Checks if the provided user name is a valid user name.<p>
67       *
68       * @param userName the user name to check
69       * 
70       * @throws CmsIllegalArgumentException if the given user name is not valid
71       */
72      void checkUserName(String   userName) throws CmsIllegalArgumentException;
73  
74      /**
75       * Checks if the provided string is a valid zipcode.<p>
76       * 
77       * @param zipcode the zipcode to validate
78       * 
79       * @throws CmsIllegalArgumentException if the given zipcode is not valid
80       */
81      void checkZipCode(String   zipcode) throws CmsIllegalArgumentException;
82  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags