View Javadoc

1   /***
2    * Copyright (C) 2009 TM-Search Community.
3    *
4    * This file is part of TM-Search Services.
5    *
6    * Foobar is free software: you can redistribute it and/or modify
7    * it under the terms of the GNU General Public License as published by
8    * the Free Software Foundation, either version 3 of the License, or
9    * (at your option) any later version.
10   *
11   * Foobar is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   * GNU General Public License for more details.
15   *
16   * You should have received a copy of the GNU General Public License
17   * along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
18   */
19  
20  package eu.europa.tmsearch.services.dao;
21  
22  import eu.europa.tmsearch.services.Cacheable;
23  import eu.europa.tmsearch.services.resources.exceptions.ResourceNotFoundException;
24  import eu.europa.tmsearch.services.schemas.trademark.applicant.ApplicantType;
25  
26  /***
27   * A DAO interface to TradeMark data store.
28   * 
29   * 
30   */
31  public interface ApplicantDAO extends Cacheable{
32  
33      /***
34       * Gets a TradeMark from the underlying data store given a template
35       * TradeMark
36       * 
37       * @param tradeMark
38       * @return A TradeMark containing the matching trade mark
39       * @throws ResourceNotFoundException
40       *             if the trade mark does not exist
41       * @see TradeMark
42       * @throws ResourceNotFoundException
43       *             if the trade mark is not found
44       */
45      public abstract ApplicantType getApplicant(String applicantId) throws ResourceNotFoundException;
46  }