View Javadoc

1   /*
2    * Copyright 2010 James Pether Sörling
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   *
16   *	$Id: ItsYourParliamentEuApi.java 4350 2010-09-02 22:12:44Z pether $
17   *  $HeadURL: https://cia.svn.sourceforge.net/svnroot/cia/trunk/service.external.itsyourparliament/src/main/java/com/hack23/cia/service/external/itsyourparliament/api/ItsYourParliamentEuApi.java $
18  */
19  package com.hack23.cia.service.external.itsyourparliament.api;
20  
21  import java.math.BigInteger;
22  import java.util.List;
23  
24  import com.hack23.cia.model.external.itsyourparliament.countries.impl.Countrydetails;
25  import com.hack23.cia.model.external.itsyourparliament.countryinfo.impl.CountryinfoEuElement;
26  import com.hack23.cia.model.external.itsyourparliament.mepinfo.impl.MepinfoEuElement;
27  import com.hack23.cia.model.external.itsyourparliament.voteinfo.impl.VoteinfoEuElement;
28  import com.hack23.cia.model.external.itsyourparliament.votes.impl.VotesEuData;
29  
30  /***
31   * The Interface ItsYourParliamentEuApi.
32   */
33  public interface ItsYourParliamentEuApi {
34  	
35  	/***
36  	 * Gets the countries.
37  	 * 
38  	 * @param accessKey
39  	 *            the access key
40  	 * @param current
41  	 *            the current
42  	 * @return the countries
43  	 * @throws Exception
44  	 *             the exception
45  	 */
46  	List<Countrydetails> getCountries(String accessKey,boolean current) throws Exception;
47  	
48  	/***
49  	 * Gets the country info.
50  	 * 
51  	 * @param id
52  	 *            the id
53  	 * @param accessKey
54  	 *            the access key
55  	 * @param current
56  	 *            the current
57  	 * @return the country info
58  	 * @throws Exception
59  	 *             the exception
60  	 */
61  	CountryinfoEuElement getCountryInfo(BigInteger id,String accessKey,boolean current) throws Exception;
62  
63  	/***
64  	 * Gets the mep info.
65  	 * 
66  	 * @param mepId
67  	 *            the mep id
68  	 * @param accessKey
69  	 *            the access key
70  	 * @param current
71  	 *            the current
72  	 * @return the mep info
73  	 * @throws Exception
74  	 *             the exception
75  	 */
76  	MepinfoEuElement getMepInfo(String mepId,String accessKey,boolean current) throws Exception;
77  
78  	/***
79  	 * Gets the vote info.
80  	 * 
81  	 * @param voteId
82  	 *            the vote id
83  	 * @param accessKey
84  	 *            the access key
85  	 * @param current
86  	 *            the current
87  	 * @return the vote info
88  	 * @throws Exception
89  	 *             the exception
90  	 */
91  	VoteinfoEuElement getVoteInfo(String voteId, String accessKey,boolean current) throws Exception;
92  
93  	/***
94  	 * Gets the votes.
95  	 * 
96  	 * @param year
97  	 *            the year
98  	 * @param accessKey
99  	 *            the access key
100 	 * @param current
101 	 *            the current
102 	 * @return the votes
103 	 * @throws Exception
104 	 *             the exception
105 	 */
106 	VotesEuData getVotes(String year,String accessKey,boolean current) throws Exception;
107 
108 }