Package dev.getelements.elements.sdk.dao

Interface LeaderboardDao

All Known Implementing Classes:

MongoLeaderboardDao

public interface LeaderboardDao

Provides CRUD operations for Leaderboard instances in the database.

Method Summary

Modifier and Type	Method	Description
Leaderboard	createLeaderboard(Leaderboard leaderboard)	Creates a Leaderboard and returns the instance as it was written to the database.
void	deleteLeaderboard(String nameOrId)	Deletes the Leaderboard with the name or identifier.
Leaderboard	getLeaderboard(String nameOrId)	Gets a single Leaderboard using the specified identifier or name.
Pagination<Leaderboard>	getLeaderboards(int offset, int count)	Lists all leaderboards, specifying offset and count.
Pagination<Leaderboard>	getLeaderboards(int offset, int count, String search)	Lists all leaderboards, specifying offset and count, as well as a search query.
Leaderboard	updateLeaderboard(String leaderboardNameOrId, Leaderboard leaderboard)	Updates an existing Leaderboard instance.

Method Details

getLeaderboards

Pagination<Leaderboard> getLeaderboards(int offset,
 int count)

Lists all leaderboards, specifying offset and count.

Parameters:

offset - the offset in the dataset

count - the number or results to return

Returns:

the Pagination<Leaderboard>

getLeaderboards

Pagination<Leaderboard> getLeaderboards(int offset,
 int count,
 String search)

Lists all leaderboards, specifying offset and count, as well as a search query.

Parameters:

offset - the offset in the dataset

count - the number or results to return

Returns:

the Pagination<Leaderboard>

getLeaderboard

Leaderboard getLeaderboard(String nameOrId)

Gets a single Leaderboard using the specified identifier or name. Throws an LeaderboardNotFoundException if not found.

Parameters:

nameOrId - the name or identifier Leaderboard.getId(), Leaderboard.getName()

Returns:

the Leaderboard instance, never null

createLeaderboard

Leaderboard createLeaderboard(Leaderboard leaderboard)

Creates a Leaderboard and returns the instance as it was written to the database.

Parameters:

leaderboard - the Leaderboard

Returns:

the Leaderboard

updateLeaderboard

Leaderboard updateLeaderboard(String leaderboardNameOrId,
 Leaderboard leaderboard)

Updates an existing Leaderboard instance. Throwing an instance of LeaderboardNotFoundException if the Leaderboard does not exist.

Parameters:

leaderboardNameOrId - the name or identifier Leaderboard.getId(), Leaderboard.getName()

leaderboard - the Leaderboard

Returns:

the Leaderboard

deleteLeaderboard

void deleteLeaderboard(String nameOrId)

Deletes the Leaderboard with the name or identifier.

Parameters:

nameOrId - the name or identifier Leaderboard.getId(), Leaderboard.getName()