|
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<ClientDefaultSettingData> net.sf.basedb.core.ClientDefaultSetting
public class ClientDefaultSetting
This class is used to represent a setting for specific client application.
Field Summary | |
---|---|
private static QueryRuntimeFilter |
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. |
Fields inherited from class net.sf.basedb.core.Setting |
---|
MAX_NAME_LENGTH, MAX_VALUE_LENGTH |
Constructor Summary | |
---|---|
ClientDefaultSetting(ClientDefaultSettingData data)
|
Method Summary | |
---|---|
static ClientDefaultSetting |
getById(DbControl dc,
int id)
Get a ClientDefaultSetting item when you know the ID. |
Client |
getClient()
Get the client application this setting is valid for. |
static ClientDefaultSetting |
getNew(DbControl dc,
Client client,
String name,
String value)
Create a new ClientDefaultSetting item. |
static ItemQuery<ClientDefaultSetting> |
getQuery(Client client)
Get a query object configured to retrieve default settings for the specified client application. |
Item |
getType()
Get the type of item represented by the object. |
(package private) void |
initPermissions(int granted,
int denied)
READ permission is granted if the logged in user has READ permission to the client application. |
(package private) void |
setClient(Client client)
Set the client application 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.CLIENTDEFAULTSETTING
,
getType()
private static final QueryRuntimeFilter RUNTIME_FILTER
Constructor Detail |
---|
ClientDefaultSetting(ClientDefaultSettingData data)
Method Detail |
---|
public static ClientDefaultSetting getNew(DbControl dc, Client client, String name, String value) throws BaseException
ClientDefaultSetting
item.
dc
- The DbControl
which will be used for
permission checking and database accessclient
- The Client
which this should be a default setting forname
- The name of the settingvalue
- The value of the setting
ClientDefaultSetting
item
BaseException
- If there is an errorClient.newDefaultSetting(String,String)
public static ClientDefaultSetting getById(DbControl dc, int id) throws ItemNotFoundException, PermissionDeniedException, BaseException
ClientDefaultSetting
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
ClientDefaultSetting
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<ClientDefaultSetting> getQuery(Client client)
client
- The client to retreive settings for, null is allowed if
the logged in user has generic READ permission for clients in which case
all settings will be returned
ItemQuery
objectClient.getDefaultSettings()
public Item getType()
Identifiable
Item
enumeration.
void initPermissions(int granted, int denied) throws BaseException
initPermissions
in class Setting<ClientDefaultSettingData>
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 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 |