com.atlassian.jira.user.util
Class GlobalUserPreferencesUtilImpl

java.lang.Object
  extended by com.atlassian.jira.user.util.GlobalUserPreferencesUtilImpl
All Implemented Interfaces:
GlobalUserPreferencesUtil

public class GlobalUserPreferencesUtilImpl
extends java.lang.Object
implements GlobalUserPreferencesUtil

This class provides methods for counting both internal users and external users (if external user mgmt is enabled) It also provides methods for updating global preferences.


Field Summary
static java.lang.String ENTITY_NAME_OS_USER
          Name of the os user entity referenced in the entitymodel.xml
 
Constructor Summary
GlobalUserPreferencesUtilImpl(OfBizDelegator ofBizDelegator, com.opensymphony.user.UserManager userManager)
           
 
Method Summary
 long getTotalUpdateUserCountMailMimeType(java.lang.String mimetype)
          Returns a count of all user entries that will have their mail settings changed.
 long getUserLocalePreferenceCount(java.lang.String localeCode)
           
 java.util.Collection getUserLocalePreferenceList(java.lang.String localeCode)
          Deprecated. do not use this, it is only for old data and will not work properly once Crowd integration is turned on
 void updateUserMailMimetypePreference(java.lang.String mimetype)
          This is used to update all users mimetype mail preference.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ENTITY_NAME_OS_USER

public static final java.lang.String ENTITY_NAME_OS_USER
Name of the os user entity referenced in the entitymodel.xml

See Also:
Constant Field Values
Constructor Detail

GlobalUserPreferencesUtilImpl

public GlobalUserPreferencesUtilImpl(OfBizDelegator ofBizDelegator,
                                     com.opensymphony.user.UserManager userManager)
Method Detail

getTotalUpdateUserCountMailMimeType

public long getTotalUpdateUserCountMailMimeType(java.lang.String mimetype)
Description copied from interface: GlobalUserPreferencesUtil
Returns a count of all user entries that will have their mail settings changed. This respects external user managment (ie we'll do a lookup in the external entities table)

Specified by:
getTotalUpdateUserCountMailMimeType in interface GlobalUserPreferencesUtil
Parameters:
mimetype - either 'text' or 'html'
Returns:
A count of the total number of users affected.

updateUserMailMimetypePreference

public void updateUserMailMimetypePreference(java.lang.String mimetype)
                                      throws org.ofbiz.core.entity.GenericEntityException
Description copied from interface: GlobalUserPreferencesUtil
This is used to update all users mimetype mail preference.

Specified by:
updateUserMailMimetypePreference in interface GlobalUserPreferencesUtil
Parameters:
mimetype - The new mimetype to use
Throws:
org.ofbiz.core.entity.GenericEntityException

getUserLocalePreferenceCount

public long getUserLocalePreferenceCount(java.lang.String localeCode)
Specified by:
getUserLocalePreferenceCount in interface GlobalUserPreferencesUtil

getUserLocalePreferenceList

public java.util.Collection getUserLocalePreferenceList(java.lang.String localeCode)
Deprecated. do not use this, it is only for old data and will not work properly once Crowd integration is turned on

Retrieve a list of usernames that have selected the specified locale in the user preferences

Specified by:
getUserLocalePreferenceList in interface GlobalUserPreferencesUtil


Copyright © 2002-2011 Atlassian. All Rights Reserved.