Skip to content

Commit

Permalink
javadoc for new habit statistic service methods
Browse files Browse the repository at this point in the history
  • Loading branch information
holotsvan committed Dec 26, 2024
1 parent f34a011 commit 4a9550d
Showing 1 changed file with 10 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -97,19 +97,24 @@ public interface HabitStatisticService {
void deleteAllStatsByHabitAssign(HabitAssignVO habitAssign);

/**
* Calculate user interest statistics.
* Calculates user interest statistics, returning the count of interactions or engagements for each interest type.
*
* @return {@code Map<String, Long>}.
* @return A {@link Map} of user interest types and their respective counts.
*/
Map<String, Long> calculateUserInterest();

/**
* Calculate how users behave with habits.
* Calculates statistics on how users interact with habits, such as creating or following habits.
*
* @return {@code Map<String, Long>}.
* @return A {@link Map} of habit behavior types and their respective counts.
*/
Map<String, Long> calculateHabitBehaviorStatistic();

// todo add javadoc
/**
* Calculates user interactions (creations and subscriptions) within a specified date range.
*
* @param range The date range (e.g., "weekly", "monthly", "yearly").
* @return A {@link Map} of interaction types ("creations", "subscriptions") and their respective counts by date.
*/
Map<String, List<HabitDateCount>> calculateInteractions(String range);
}

0 comments on commit 4a9550d

Please sign in to comment.