[LIB-2] Add snooker-score-api source files
[snooker-score-api.git] / src / main / java / org / hedgecode / snooker / api / SnookerScoreAPI.java
1 /*
2  * Copyright (c) 2017. Developed by Hedgecode.
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
17 package org.hedgecode.snooker.api;
18
19 /**
20  * Snooker Score API for external applications.
21  *
22  * @author Dmitry Samoshin aka gotty
23  */
24 public interface SnookerScoreAPI {
25
26     Event getEvent(int eventId) throws APIException;
27
28     Match getMatch(int eventId, int roundId, int matchNumber) throws APIException;
29
30     Player getPlayer(int playerId) throws APIException;
31
32     Events getSeasonEvents(Season season) throws APIException;
33
34     Matches getEventMatches(int eventId) throws APIException;
35
36     OngoingMatches getOngoingMatches() throws APIException;
37
38     Matches getPlayerMatches(int playerId, Season season) throws APIException;
39
40     Players getEventPlayers(int eventId) throws APIException;
41
42     Players getPlayers(Season season, PlayerCategory category) throws APIException;
43
44     Rankings getRankings(Season season, RankingType type) throws APIException;
45
46     void setCurrentSeason(Season season) throws APIException;
47
48     Season currentSeason() throws APIException;
49
50 }