public class UserDefaultSetting extends Setting<UserDefaultSettingData>
Modifier and Type | Field and Description |
---|---|
private static QueryRuntimeFilter |
RUNTIME_FILTER
This filter will only return items if the logged in user has
generic read permission to users.
|
static Item |
TYPE
The type of item represented by this class.
|
MAX_NAME_LENGTH, MAX_VALUE_LENGTH
Constructor and Description |
---|
UserDefaultSetting(UserDefaultSettingData data) |
Modifier and Type | Method and Description |
---|---|
static UserDefaultSetting |
getById(DbControl dc,
int id)
Get a
UserDefaultSetting item when you know the ID. |
static UserDefaultSetting |
getNew(DbControl dc,
User user,
String name,
String value)
Create a new
UserDefaultSetting item. |
static ItemQuery<UserDefaultSetting> |
getQuery(User user)
Get a query configured to retrieve default settings for a user.
|
Item |
getType()
Get the type of item represented by the object.
|
User |
getUser()
Get the user this setting is valid for.
|
(package private) void |
initPermissions(int granted,
int denied)
READ permission is granted if the logged in user is the owner of this
setting.
|
(package private) void |
setUser(User user)
Set the user this setting is valid for.
|
addUsingItems, addUsingItems, checkPermission, equals, getData, getDbControl, getId, getPermissions, getPluginPermissions, getSessionControl, getUsingItems, getVersion, hashCode, hasPermission, isDetached, isInDatabase, isUsed, onAfterCommit, onAfterInsert, onBeforeCommit, onRollback, setDbControl, setProjectDefaults, toString, validate
public static final Item TYPE
Item.USERDEFAULTSETTING
,
getType()
private static final QueryRuntimeFilter RUNTIME_FILTER
UserDefaultSetting(UserDefaultSettingData data)
public static UserDefaultSetting getNew(DbControl dc, User user, String name, String value) throws BaseException
UserDefaultSetting
item.dc
- The DbControl
which will be used for
permission checking and database accessuser
- The User
which this should be a default setting forname
- The name of the settingvalue
- The value of the settingUserDefaultSetting
itemBaseException
- If there is an errorUser.newDefaultSetting(String,String)
public static UserDefaultSetting getById(DbControl dc, int id) throws ItemNotFoundException, PermissionDeniedException, BaseException
UserDefaultSetting
item when you know the ID.dc
- The DbControl
which will be used for
permission checking and database access.id
- The ID of the item to loadUserDefaultSetting
itemItemNotFoundException
- If an item with the specified
ID is not foundPermissionDeniedException
- If the logged in user doesn't
have Permission.READ
permission to the itemBaseException
- If there is another errorpublic static ItemQuery<UserDefaultSetting> getQuery(User user)
user
- The user to retreive settings for, null is allowed if
the logged in user has generic READ permission for users in which case
all settings will be returnedItemQuery
objectUser.getDefaultSettings()
public Item getType()
Identifiable
Item
enumeration.void initPermissions(int granted, int denied) throws BaseException
initPermissions
in class Setting<UserDefaultSettingData>
granted
- Permissions that have been granted by the subclassdenied
- Permissions that have been denied by the subclassBaseException
- If the permissions couldn't be initialisedpublic User getUser() throws PermissionDeniedException, BaseException
User
itemPermissionDeniedException
- If the logged in user doesn't have
Permission.READ
permissionBaseException
- If there is another errorvoid setUser(User user) throws PermissionDeniedException, InvalidDataException
InvalidDataException
- If the user is nullPermissionDeniedException