|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.basedb.core.BasicItem<D> net.sf.basedb.core.Setting<UserClientSettingData> net.sf.basedb.core.UserClientSetting
public class UserClientSetting
This class is used to represent a setting valid for a specific user using a specific client application.
Field Summary | |
---|---|
private static QueryRuntimeFilter |
CLIENT_RUNTIME_FILTER
This filter will only return items if the logged in user has generic read permission to clients. |
static Item |
TYPE
The type of item represented by this class. |
private static QueryRuntimeFilter |
USER_RUNTIME_FILTER
This filter will only return items if the logged in user has generic read permission to users. |
private static QueryRuntimeFilter |
USERCLIENT_RUNTIME_FILTER
This filter will only return items if the logged in user has generic read permission to users and clients. |
Fields inherited from class net.sf.basedb.core.Setting |
---|
MAX_NAME_LENGTH, MAX_VALUE_LENGTH |
Constructor Summary | |
---|---|
UserClientSetting(UserClientSettingData data)
|
Method Summary | |
---|---|
static UserClientSetting |
getById(DbControl dc,
int id)
Get a UserClientSetting item when you know the ID. |
Client |
getClient()
Get the client application this setting is valid for. |
static UserClientSetting |
getNew(DbControl dc,
User user,
Client client,
String name,
String value)
Create a new UserClientSetting item. |
static ItemQuery<UserClientSetting> |
getQuery(User user,
Client client)
Get a query configured to retrieve client specific 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 |
setClient(Client client)
Set the client application this setting is valid for. |
(package private) void |
setUser(User user)
Set the user this setting is valid for. |
Methods inherited from class net.sf.basedb.core.Setting |
---|
getName, getValue, setName, setValue |
Methods inherited from class net.sf.basedb.core.BasicItem |
---|
addUsingItems, addUsingItems, checkPermission, equals, getData, getDbControl, getId, getPermissions, getPluginPermissions, getSessionControl, getUsingItems, getVersion, hashCode, hasPermission, isDetached, isInDatabase, isUsed, onAfterCommit, onAfterInsert, onBeforeCommit, onRollback, setDbControl, setProjectDefaults, toString, toTransferable, validate |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final Item TYPE
Item.USERCLIENTSETTING
,
getType()
private static final QueryRuntimeFilter CLIENT_RUNTIME_FILTER
private static final QueryRuntimeFilter USER_RUNTIME_FILTER
private static final QueryRuntimeFilter USERCLIENT_RUNTIME_FILTER
Constructor Detail |
---|
UserClientSetting(UserClientSettingData data)
Method Detail |
---|
public static UserClientSetting getNew(DbControl dc, User user, Client client, String name, String value) throws BaseException
UserClientSetting
item.
dc
- The DbControl
which will be used for
permission checking and database accessuser
- The User
which this should be a setting forclient
- The Client
which this should be a setting forname
- The name of the settingvalue
- The value of the setting
UserClientSetting
item
BaseException
- If there is an errorpublic static UserClientSetting getById(DbControl dc, int id) throws ItemNotFoundException, PermissionDeniedException, BaseException
UserClientSetting
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 load
UserClientSetting
item
ItemNotFoundException
- If an item with the specified
ID is not found
PermissionDeniedException
- If the logged in user doesn't
have Permission.READ
permission to the item
BaseException
- If there is another errorpublic static ItemQuery<UserClientSetting> getQuery(User user, Client client)
user
- The user to retreive settings for, null is allowed if
the logged in user has generic READ permission for all users in which case
all settings will be returnedclient
- The client to retreive settings for, null is allowed if
the logged in user has generic READ permission for all clients in which case
all settings will be returned
ItemQuery
objectpublic Item getType()
Identifiable
Item
enumeration.
void initPermissions(int granted, int denied) throws BaseException
initPermissions
in class Setting<UserClientSettingData>
granted
- Permissions that have been granted by the subclassdenied
- Permissions that have been denied by the subclass
BaseException
- If the permissions couldn't be initialisedpublic User getUser() throws PermissionDeniedException, BaseException
User
item
PermissionDeniedException
- If the logged in user doesn't have
Permission.READ
permission
BaseException
- If there is another errorvoid setUser(User user) throws PermissionDeniedException, InvalidDataException
InvalidDataException
- If the user is null
PermissionDeniedException
public Client getClient() throws PermissionDeniedException, BaseException
Client
item
PermissionDeniedException
- If the logged in user doesn't have
Permission.READ
permission
BaseException
- If there is another errorvoid setClient(Client client) throws PermissionDeniedException, InvalidDataException
InvalidDataException
- If the client is null
PermissionDeniedException
|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |