Package dev.getelements.elements.sdk.dao

Interface RankDao

All Known Implementing Classes:
MongoRankDao
public interface RankDao
Provides access to Rank instances stored in the database, correlating and filtering data as necessary.

  • Method Details

    • getRanksForGlobal

      Pagination<Rank> getRanksForGlobal(String leaderboardNameOrId, int offset, int count, long leaderboardEpoch)
      Given the Leaderboard name or ID, this will return all Rank instances sorted in order.
      Parameters:
      leaderboardNameOrId - the value of Leaderboard.getId() or Leaderboard.getName()
      offset - the offset in the dataset
      count - the number of results to return
      leaderboardEpoch - the epoch timestamp
      Returns:
      a Pagination<Rank> containing all ranks

    • getRanksForGlobalRelative

      Pagination<Rank> getRanksForGlobalRelative(String leaderboardNameOrId, String profileId, int offset, int count, long leaderboardEpoch)
      Given the Leaderboard name or ID, this will return all Rank instances sorted in order. This allows the the result set to be skipped forward to make the supplied Profile appear in= the result set.
      Parameters:
      leaderboardNameOrId - the value of Leaderboard.getId() or Leaderboard.getName()
      profileId - the value of Profile.getId()
      count - the number of results to return
      leaderboardEpoch - the epoch timestamp
      Returns:
      a Pagination<Rank> containing all ranks

    • getRanksForFriends

      Pagination<Rank> getRanksForFriends(String leaderboardNameOrId, String profileId, int offset, int count, long leaderboardEpoch)
      Given the Leaderboard name or ID, this will return all Rank instances sorted in order. This allows the the result set to be skipped forward to make the supplied Profile appear int the result set.
      Parameters:
      leaderboardNameOrId - the value of Leaderboard.getId() or Leaderboard.getName()
      profileId - the value of Profile.getId()
      offset - the offset in the dataset, may be negative
      count - the number of results to return
      leaderboardEpoch - the epoch timestamp
      Returns:
      a Pagination<Rank> containing all ranks

    • getRanksForFriendsRelative

      Pagination<Rank> getRanksForFriendsRelative(String leaderboardNameOrId, String profileId, int offset, int count, long leaderboardEpoch)
      Given the Leaderboard name or ID, this will return all Rank instances sorted in order. This allows the the result set to be skipped forward to make the supplied Profile appear int the result set.

      Additionally this will filter the results to only include friends of the supplied Profile.

      Parameters:
      leaderboardNameOrId - the value of Leaderboard.getId() or Leaderboard.getName()
      profileId - the value of Profile.getId()
      offset - the offset in the dataset, may be negative
      count - the number of results to return @return a Pagination<Rank> containing all ranks
      leaderboardEpoch - the epoch timestamp

    • getRanksForMutualFollowers

      Pagination<Rank> getRanksForMutualFollowers(String leaderboardNameOrId, String profileId, int offset, int count, long leaderboardEpoch)
      Given the Leaderboard name or ID, this will return all Rank instances sorted in order. This allows the the result set to be skipped forward to make the supplied Profile appear int the result set.
      Parameters:
      leaderboardNameOrId - the value of Leaderboard.getId() or Leaderboard.getName()
      profileId - the value of Profile.getId()
      offset - the offset in the dataset, may be negative
      count - the number of results to return
      leaderboardEpoch - the epoch timestamp
      Returns:
      a Pagination<Rank> containing all ranks

    • getRanksForMutualFollowersRelative

      Pagination<Rank> getRanksForMutualFollowersRelative(String leaderboardNameOrId, String profileId, int offset, int count, long leaderboardEpoch)
      Given the Leaderboard name or ID, this will return all Rank instances sorted in order. This allows the the result set to be skipped forward to make the supplied Profile appear int the result set.

      Additionally this will filter the results to only include friends of the supplied Profile.

      Parameters:
      leaderboardNameOrId - the value of Leaderboard.getId() or Leaderboard.getName()
      profileId - the value of Profile.getId()
      offset - the offset in the dataset, may be negative
      count - the number of results to return @return a Pagination<Rank> containing all ranks
      leaderboardEpoch - the epoch timestamp

    • getRanksForGlobalTabular

      Tabulation<RankRow> getRanksForGlobalTabular(String leaderboardNameOrId, long leaderboardEpoch)
      Gets the ranks for a leaderboard as a tabulation.
      Parameters:
      leaderboardNameOrId - the value of Leaderboard.getId() or Leaderboard.getName()
      leaderboardEpoch - the epoch timestamp
      Returns:
      the tabular