Package dev.getelements.elements.sdk.dao

Interface MatchDao

All Known Implementing Classes:

MongoMatchDao

public interface MatchDao

Created by patricktwohig on 7/20/17.

Method Summary

Modifier and Type	Method	Description
Match	createMatch(Match match)	Crates an instance of Match in the database.
void	deleteMatch(String profileId, String matchId)	Delets a Match, specyifying the id of the Match.
Matchmaker	getDefaultMatchmaker()	Returns the default Matchmaker instance.
Pagination<Match>	getMatchesForPlayer(String playerId, int offset, int count)	Fetches all Match instances with the given profile ID, and match ID.
Pagination<Match>	getMatchesForPlayer(String playerId, int offset, int count, String search)	Fetches all Match instances with the given profile ID, and match ID.
Match	getMatchForPlayer(String playerId, String matchId)	Fetches a Match with the given profile ID, and match ID.

Method Details

getMatchForPlayer

Match getMatchForPlayer(String playerId,
 String matchId)
                 throws NotFoundException

Fetches a Match with the given profile ID, and match ID. If no such match is found, then this throws an instance of NotFoundException.

The profile ID is compared against the ID of Match.getPlayer()

Parameters:

playerId - as specified by the value of Profile.getId() of Match.getPlayer()

matchId - the mach id as determined by Match.getId()

Returns:

the Match, never null

Throws:

NotFoundException - if the match is not found.

getMatchesForPlayer

Pagination<Match> getMatchesForPlayer(String playerId,
 int offset,
 int count)

Fetches all Match instances with the given profile ID, and match ID. If no such match is found, then this throws an instance of NotFoundException.

The profile ID is compared against the ID of Match.getPlayer()

Parameters:

playerId - as specified by the value of Profile.getId() of Match.getPlayer()

offset - the offset

count - the count

Returns:

the Match, never null

Throws:

NotFoundException - if the match is not found.

getMatchesForPlayer

Pagination<Match> getMatchesForPlayer(String playerId,
 int offset,
 int count,
 String search)

Fetches all Match instances with the given profile ID, and match ID. If no such match is found, then this throws an instance of NotFoundException.

The profile ID is compared against the ID of Match.getPlayer()

Parameters:

playerId - as specified by the value of Profile.getId() of Match.getPlayer()

offset - the offset

count - the count

search - a search query to filter Match instances

Returns:

the Match, never null

Throws:

NotFoundException - if the match is not found.

createMatch

Match createMatch(Match match)

Crates an instance of Match in the database. Note that this does not

Parameters:

match - the Match to create

Returns:

a Match as it was written to the database

getDefaultMatchmaker

Matchmaker getDefaultMatchmaker()

Returns the default Matchmaker instance.

Returns:

a Matchmaker

Throws:

NotImplementedException - if the supplied algorithm is not supported.

deleteMatch

void deleteMatch(String profileId,
 String matchId)

Delets a Match, specyifying the id of the Match. Note that a Match may not be deleted if it is already matched to an opponent.

Parameters:

profileId - the id of the Profile as determined by Profile.getId()

matchId - the id of the Match, specified by Match.getId()