public interface

UserStatusDao

implements ContentEntityObjectDao
com.atlassian.confluence.userstatus.UserStatusDao
Known Indirect Subclasses

Class Overview

Interface to the persisted user status objects

Summary

Public Methods
void clearCurrentUserStatus(String username)
Clears the current status of the specified user
void clearCurrentUserStatus(User user)
Clears the current status of the specified user
void clearUserStatus(UserStatus status)
Clears the specified status if it is current
List<UserStatus> getAllByUser(User user, int maxResults)
Returns a list of user status updates from a specified user with a specified number of results.
List<UserStatus> getAllByUser(String username, int maxResults)
Returns a list of user status updates from a specified user with a specified number of results.
List<UserStatus> getAllByUser(String username)
Return a list of all user status updates from the specified user
List<UserStatus> getAllByUser(User user)
Return a list of all user status updates from the specified user.
UserStatus getById(long id)
Gets a user status by its id
UserStatus getByUser(String username)
Gets the current user status.
UserStatus getByUser(User user)
Gets the current user status.
int getUserStatusCount(User user)
Returns the total number of user statuses stored against the specified user.
int getUserStatusCount(String username)
Returns the total number of user statuses stored against the specified user.
void removeAllStatusesForUser(String username)
Remove all user statuses for a particular user
void removeAllStatusesForUser(User user)
Remove all user statuses for a particular user
[Expand]
Inherited Methods
From interface bucket.core.persistence.ObjectDao
From interface com.atlassian.confluence.core.persistence.ContentEntityObjectDao
From interface com.atlassian.confluence.core.persistence.VersionedObjectDao

Public Methods

public void clearCurrentUserStatus (String username)

Clears the current status of the specified user

Parameters
username - the user to clear the status for

public void clearCurrentUserStatus (User user)

Clears the current status of the specified user

Parameters
user - the user to clear the status for

public void clearUserStatus (UserStatus status)

Clears the specified status if it is current

Parameters
status - the status to clear

public List<UserStatus> getAllByUser (User user, int maxResults)

Returns a list of user status updates from a specified user with a specified number of results. If there are no statuses an empty list is returned.

Parameters
user the user to find status updates for
maxResults the maximum number of results to return
Returns
  • a list of user status updates

public List<UserStatus> getAllByUser (String username, int maxResults)

Returns a list of user status updates from a specified user with a specified number of results. If there are no statuses an empty list is returned.

Parameters
username the user to find status updates for
maxResults the maximum number of results to return
Returns
  • a list of user status updates

public List<UserStatus> getAllByUser (String username)

Return a list of all user status updates from the specified user

Parameters
username the username of user to find status updates for
Returns
  • a list of user status updates

public List<UserStatus> getAllByUser (User user)

Return a list of all user status updates from the specified user. If there are no statuses an empty list is returned.

Parameters
user the user to find status updates for
Returns
  • a list of user status updates

public UserStatus getById (long id)

Gets a user status by its id

Parameters
id the status id
Returns
  • a user status

public UserStatus getByUser (String username)

Gets the current user status. If there is no status for that user null is returned.

Parameters
username the specified user name
Returns
  • the current user status, or null if no status exists

public UserStatus getByUser (User user)

Gets the current user status. If there is no status for that user null is returned.

Parameters
user the user object
Returns
  • the current user status, or null if no status exists

public int getUserStatusCount (User user)

Returns the total number of user statuses stored against the specified user.

Parameters
user the user to count the statuses for
Returns
  • the number of user statuses

public int getUserStatusCount (String username)

Returns the total number of user statuses stored against the specified user.

Parameters
username the user to count the statuses for
Returns
  • the number of user statuses

public void removeAllStatusesForUser (String username)

Remove all user statuses for a particular user

Parameters
username - name of the specified user

public void removeAllStatusesForUser (User user)

Remove all user statuses for a particular user

Parameters
user - the specified user