View Javadoc

1   /*
2    * JCaptcha, the open source java framework for captcha definition and integration
3    * Copyright (c)  2007 jcaptcha.net. All Rights Reserved.
4    * See the LICENSE.txt file distributed with this package.
5    */
6   
7   package com.octo.captcha.service.text;
8   
9   import com.octo.captcha.service.CaptchaService;
10  import com.octo.captcha.service.CaptchaServiceException;
11  
12  import java.util.Locale;
13  
14  /***
15   * <p><ul><li></li></ul></p>
16   *
17   * @author <a href="mailto:marc.antoine.garrigue@gmail.com">Marc-Antoine Garrigue</a>
18   * @version 1.0
19   */
20  public interface TextCaptchaService extends CaptchaService {
21      /***
22       * Method to retrive the text challenge corresponding to the given ticket.
23       *
24       * @param ID the ticket
25       * @return the challenge
26       * @throws com.octo.captcha.service.CaptchaServiceException
27       *          if the ticket is invalid
28       */
29      String getTextChallengeForID(String ID) throws CaptchaServiceException;
30  
31      /***
32       * Method to retrieve the text challenge corresponding to the given ticket.
33       *
34       * @param ID the ticket
35       * @return the challenge
36       * @throws com.octo.captcha.service.CaptchaServiceException
37       *          if the ticket is invalid
38       */
39      String getTextChallengeForID(String ID, Locale locale) throws CaptchaServiceException;
40  
41  }