com.atlassian.greenhopper.service.properties
Interface UserPropertyService

All Known Implementing Classes:
UserPropertyServiceImpl

public interface UserPropertyService

Provides access to user properties. For logged in users this information is stored in the user properties, for anonymous users the information is kept in the session.


Method Summary
 boolean hasUserCompletedRapidBoardWelcomeMat(com.atlassian.crowd.embedded.api.User user)
          Has the user "completed" the welcome mat for the Rapid Board? This is defined as having successfully created a new project, created a new Rapid View or found an existing Rapid View.
 boolean hasUserDismissedAnalyticsMessage(com.atlassian.crowd.embedded.api.User user)
          Has the user dismissed the analytics opt-in message
 boolean hasUserDismissedClassicBoardsWarning(com.atlassian.crowd.embedded.api.User user)
          Has the user dismissed the classic boards warning message
 boolean hasUserSeenChartIntro(com.atlassian.crowd.embedded.api.User user)
          Has the user "completed" the chart intro for rapid board? Defined as having clicked through to one of the charts from the intro.
 boolean isRapidViewSelected(com.atlassian.crowd.embedded.api.User user)
          Is the Rapid Board the currently selected "view"? This is kept separate from the user board settings as the rapid board is non-project specific.
 void setHasUserDismissedAnalyticsMessage(boolean hasDismissed, com.atlassian.crowd.embedded.api.User user)
          Set whether or not the user has seen the analytics opt-in message
 void setHasUserDismissedClassicBoardsWarning(boolean hasDismissed, com.atlassian.crowd.embedded.api.User user)
          Set whether or not the user has dismissed the classic boards warning message
 void setHasUserSeenChartIntro(boolean hasSeen, com.atlassian.crowd.embedded.api.User user)
          Sets whether or not the user has completed the chart intro
 void setRapidViewSelected(boolean selected, com.atlassian.crowd.embedded.api.User user)
          Set whether the rapid view is currently selected.
 void setUserCompletedRapidBoardWelcomeMat(boolean completed, com.atlassian.crowd.embedded.api.User user)
          Set whether or not the user has completed the welcome mat for Rapid Board
 

Method Detail

isRapidViewSelected

boolean isRapidViewSelected(com.atlassian.crowd.embedded.api.User user)
Is the Rapid Board the currently selected "view"? This is kept separate from the user board settings as the rapid board is non-project specific.

Parameters:
user - if null then anonymous user is assumed (session based storage is used)
Returns:
true if the rapid board is currently selected, false otherwise. Falls back to false.

setRapidViewSelected

void setRapidViewSelected(boolean selected,
                          com.atlassian.crowd.embedded.api.User user)
Set whether the rapid view is currently selected.

Parameters:
selected - boolean
user - if null then anonymous user is assumed (session based storage is used)

hasUserCompletedRapidBoardWelcomeMat

boolean hasUserCompletedRapidBoardWelcomeMat(com.atlassian.crowd.embedded.api.User user)
Has the user "completed" the welcome mat for the Rapid Board? This is defined as having successfully created a new project, created a new Rapid View or found an existing Rapid View. Additionally if they click on the External Import link, this is counted as completed.

Parameters:
user - if null then anonymous user is assumed (session based storage is used)
Returns:
true if completed; false otherwise.

setUserCompletedRapidBoardWelcomeMat

void setUserCompletedRapidBoardWelcomeMat(boolean completed,
                                          com.atlassian.crowd.embedded.api.User user)
Set whether or not the user has completed the welcome mat for Rapid Board

Parameters:
completed - boolean
user - if null then anonymous user is assumed (session based storage is used)

hasUserSeenChartIntro

boolean hasUserSeenChartIntro(com.atlassian.crowd.embedded.api.User user)
Has the user "completed" the chart intro for rapid board? Defined as having clicked through to one of the charts from the intro.

Parameters:
user - if null then anonymous user is assumed (session based storage is used)
Returns:
true if seen, false otherwise

setHasUserSeenChartIntro

void setHasUserSeenChartIntro(boolean hasSeen,
                              com.atlassian.crowd.embedded.api.User user)
Sets whether or not the user has completed the chart intro

Parameters:
hasSeen - boolean
user - if null then anonymous user is assumed (session based storage is used)

hasUserDismissedAnalyticsMessage

boolean hasUserDismissedAnalyticsMessage(com.atlassian.crowd.embedded.api.User user)
Has the user dismissed the analytics opt-in message


setHasUserDismissedAnalyticsMessage

void setHasUserDismissedAnalyticsMessage(boolean hasDismissed,
                                         com.atlassian.crowd.embedded.api.User user)
Set whether or not the user has seen the analytics opt-in message


hasUserDismissedClassicBoardsWarning

boolean hasUserDismissedClassicBoardsWarning(com.atlassian.crowd.embedded.api.User user)
Has the user dismissed the classic boards warning message


setHasUserDismissedClassicBoardsWarning

void setHasUserDismissedClassicBoardsWarning(boolean hasDismissed,
                                             com.atlassian.crowd.embedded.api.User user)
Set whether or not the user has dismissed the classic boards warning message



Copyright © 2007-2012 Atlassian. All Rights Reserved.