com.atlassian.confluence.userstatus
Interface UserStatusManager

All Superinterfaces:
ContentEntityManager
All Known Implementing Classes:
DefaultUserStatusManager

public interface UserStatusManager
extends ContentEntityManager

Used to retrieve and store the user status for a user


Field Summary
 
Fields inherited from interface com.atlassian.confluence.core.ContentEntityManager
ITERATE_ALL
 
Method Summary
 void clearCurrentUserStatus(String username)
          Clears the current status of the specified user
 void clearCurrentUserStatus(com.atlassian.user.User user)
          Clears the current status of the specified user
 UserStatus getUserStatus(long id)
          Retrieve the user status for the given status id
 UserStatus getUserStatus(String username)
          Retrieve the current user status for the given user
 UserStatus getUserStatus(com.atlassian.user.User user)
          Retrieve the current user status for the given user
 int getUserStatusCount(String username)
          Returns the total number of statuses set against the specified user
 int getUserStatusCount(com.atlassian.user.User user)
          Returns the total number of statuses set against the specified user
 List<UserStatus> getUserStatusList(String username)
          Retrieve a list of user status items for the specified user
 List<UserStatus> getUserStatusList(String username, int maxResults)
          Retrieve a list of user status items for the specified user
 List<UserStatus> getUserStatusList(com.atlassian.user.User user)
          Retrieve a list of user status items for the specified user
 List<UserStatus> getUserStatusList(com.atlassian.user.User user, int maxResults)
          Retrieve a list of user status items for the specified user
 void removeAllStatusForUser(com.atlassian.user.User user)
          Deletes all user status' for the specified user
 UserStatus saveUserStatus(ConfluenceUser user, String statusText)
          Saves a new status.
 UserStatus saveUserStatus(ConfluenceUser user, String statusText, Space targetSpace)
          Saves a new status, targeted to a specific space.
 UserStatus saveUserStatus(String username, String statusText)
          Deprecated. since 5.2. See saveUserStatus(ConfluenceUser, String)
 UserStatus saveUserStatus(String username, String statusText, Space targetSpace)
          Deprecated. since 5.2. See saveUserStatus(ConfluenceUser, String, Space)
 UserStatus saveUserStatus(UserStatus status)
          Saves a status
 
Methods inherited from interface com.atlassian.confluence.core.ContentEntityManager
getById, getNextVersion, getOtherVersion, getPreviousVersion, getRecentlyAddedEntities, getRecentlyModifiedEntities, getRecentlyModifiedEntitiesForUser, getRecentlyModifiedForChangeDigest, getVersionHistorySummaries, refreshContentEntity, removeContentEntity, removeHistoricalVersion, revertContentEntityBackToVersion, saveContentEntity, saveContentEntity, saveNewVersion, saveNewVersion, setEventManager, updateContentLinkingTo, updateOutgoingLinksInContent, updateSingleContentLinkinTo, updateSingleContentLinkinTo
 

Method Detail

getUserStatusList

List<UserStatus> getUserStatusList(String username)
Retrieve a list of user status items for the specified user

Parameters:
username - the username of the user to find status updates for
Returns:
a list of user status objects

getUserStatusList

List<UserStatus> getUserStatusList(com.atlassian.user.User user)
Retrieve a list of user status items for the specified user

Parameters:
user - the user to find status updates for
Returns:
a list of user status objects

getUserStatusList

List<UserStatus> getUserStatusList(String username,
                                   int maxResults)
Retrieve a list of user status items for the specified user

Parameters:
username - the username of the user to find status updates for
maxResults - the maximum number of statuses to return
Returns:
a list of user status objects

getUserStatusList

List<UserStatus> getUserStatusList(com.atlassian.user.User user,
                                   int maxResults)
Retrieve a list of user status items for the specified user

Parameters:
user - the user to find status updates for
maxResults - the maximum number of statuses to return
Returns:
a list of user status objects

getUserStatus

UserStatus getUserStatus(String username)
Retrieve the current user status for the given user

Parameters:
username - the username of the user to get the status for
Returns:
user status

getUserStatus

UserStatus getUserStatus(com.atlassian.user.User user)
Retrieve the current user status for the given user

Parameters:
user - the user to get the status for
Returns:
user status

saveUserStatus

@Deprecated
UserStatus saveUserStatus(String username,
                                     String statusText)
Deprecated. since 5.2. See saveUserStatus(ConfluenceUser, String)

Saves a new status.

Parameters:
username - The user to save the status against
statusText - Text for the new status
Returns:
The persisted status object

saveUserStatus

@Deprecated
UserStatus saveUserStatus(String username,
                                     String statusText,
                                     Space targetSpace)
Deprecated. since 5.2. See saveUserStatus(ConfluenceUser, String, Space)

Saves a new status, targeted to a specific space.

Parameters:
username - The user to save the status against
statusText - Text for the new status
targetSpace - The space to target the status to
Returns:
The persisted status object

saveUserStatus

UserStatus saveUserStatus(ConfluenceUser user,
                          String statusText)
Saves a new status.

Parameters:
user - The user to save the status against
statusText - Text for the new status
Returns:
The persisted status object

saveUserStatus

UserStatus saveUserStatus(ConfluenceUser user,
                          String statusText,
                          Space targetSpace)
Saves a new status, targeted to a specific space.

Parameters:
user - The user to save the status against
statusText - Text for the new status
targetSpace - The space to target the status to
Returns:
The persisted status object

saveUserStatus

UserStatus saveUserStatus(UserStatus status)
Saves a status

Parameters:
status - the status to be saved
Returns:
The status that was passed in as a parameter

clearCurrentUserStatus

void clearCurrentUserStatus(com.atlassian.user.User user)
Clears the current status of the specified user

Parameters:
user - - the user to clear the status for

clearCurrentUserStatus

void clearCurrentUserStatus(String username)
Clears the current status of the specified user

Parameters:
username - - the user to clear the status for

getUserStatus

UserStatus getUserStatus(long id)
Retrieve the user status for the given status id

Parameters:
id - the id of the user status object
Returns:
user status

getUserStatusCount

int getUserStatusCount(String username)
Returns the total number of statuses set against the specified user

Parameters:
username - the user to count statuses for
Returns:
total number of statuses set

getUserStatusCount

int getUserStatusCount(com.atlassian.user.User user)
Returns the total number of statuses set against the specified user

Parameters:
user - the user to count statuses for
Returns:
total number of statuses set

removeAllStatusForUser

void removeAllStatusForUser(com.atlassian.user.User user)
Deletes all user status' for the specified user

Parameters:
user - the user to clear the statuses for
Throws:
IllegalArgumentException - if user is null


Copyright © 2003–2015 Atlassian. All rights reserved.