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

Modifier and Type	Method and Description
List<String>	getQuickCreateFields(com.atlassian.jira.user.ApplicationUser user) Returns a list of the fields for the custom quick create form that the user last saw
String	getQuickCreateIssueTypeId() Returns the issue type id for the custom quick create form that the user last saw
Boolean	getUseQuickFormPreference(com.atlassian.jira.user.ApplicationUser user) Has the user last viewed the quick form or the form with all fields
boolean	hasUserCompletedRapidBoardWelcomeMat(com.atlassian.jira.user.ApplicationUser 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	hasUserDismissedClassicBoardsEOLWarning(com.atlassian.jira.user.ApplicationUser user) Has the user dismissed the classic boards warning message
boolean	isRapidViewSelected(com.atlassian.jira.user.ApplicationUser 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	setHasUserDismissedClassicBoardsEOLWarning(boolean hasDismissed, com.atlassian.jira.user.ApplicationUser user) Set whether or not the user has dismissed the classic boards warning message
void	setQuickCreateFields(com.atlassian.jira.user.ApplicationUser user, List<String> string) Store the list of the fields to be used for the custom quck create form.
void	setQuickCreateIssueTypeId(String issueTypeId) Store the quick create issue type id for the current user
void	setRapidViewSelected(boolean selected, com.atlassian.jira.user.ApplicationUser user) Set whether the rapid view is currently selected.
void	setUseQuickFormPreference(com.atlassian.jira.user.ApplicationUser user, boolean useQuickForm) Store the preference for whether to use the quick create form (custom fields) or long form (all fields)
void	setUserCompletedRapidBoardWelcomeMat(boolean completed, com.atlassian.jira.user.ApplicationUser user) Set whether or not the user has completed the welcome mat for Rapid Board

Method Detail

isRapidViewSelected

boolean isRapidViewSelected(com.atlassian.jira.user.ApplicationUser 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.jira.user.ApplicationUser 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.jira.user.ApplicationUser 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.jira.user.ApplicationUser 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)

hasUserDismissedClassicBoardsEOLWarning

boolean hasUserDismissedClassicBoardsEOLWarning(com.atlassian.jira.user.ApplicationUser user)

Has the user dismissed the classic boards warning message

setHasUserDismissedClassicBoardsEOLWarning

void setHasUserDismissedClassicBoardsEOLWarning(boolean hasDismissed,
                                                com.atlassian.jira.user.ApplicationUser user)

Set whether or not the user has dismissed the classic boards warning message

getQuickCreateIssueTypeId

String getQuickCreateIssueTypeId()

Returns the issue type id for the custom quick create form that the user last saw

Returns:

setQuickCreateIssueTypeId

void setQuickCreateIssueTypeId(String issueTypeId)

Store the quick create issue type id for the current user

Parameters:

issueTypeId - the id of the issue type

getQuickCreateFields

List<String> getQuickCreateFields(com.atlassian.jira.user.ApplicationUser user)

Returns a list of the fields for the custom quick create form that the user last saw

Parameters:

user - current logged in user

Returns:

List of field names

setQuickCreateFields

void setQuickCreateFields(com.atlassian.jira.user.ApplicationUser user,
                          List<String> string)

Store the list of the fields to be used for the custom quck create form.

Parameters:

user - current logged in user

string - List of field names

getUseQuickFormPreference

Boolean getUseQuickFormPreference(com.atlassian.jira.user.ApplicationUser user)

Has the user last viewed the quick form or the form with all fields

Parameters:

user - current logged in user

Returns:

true for quick form, false for long form

setUseQuickFormPreference

void setUseQuickFormPreference(com.atlassian.jira.user.ApplicationUser user,
                               boolean useQuickForm)

Store the preference for whether to use the quick create form (custom fields) or long form (all fields)

Parameters:

user - currently logged in user

useQuickForm - true for quick form, false for long form