|
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<D>
public abstract class Setting<D extends SettingData>
This is the base class for all setting items. There are four types of settings:
UserClientSetting
: Specific for a user using a client
application.
UserDefaultSetting
: Specific for a user, valid for all
client applications.
ClientDefaultSetting
: Specific for a client application,
valid for all users.
GlobalDefaultSetting
: Valid for all users and client applications.
Field Summary | |
---|---|
static int |
MAX_NAME_LENGTH
The maximum length of the name that can be stored in the database. |
static int |
MAX_VALUE_LENGTH
The maximum length of the value that can be stored in the database. |
static Item |
TYPE
The type of item represented by this class. |
Constructor Summary | |
---|---|
Setting(D settingData)
|
Method Summary | |
---|---|
static Setting |
getById(DbControl dc,
int id)
Get a Setting item when you know the ID. |
String |
getName()
Get the name of this setting. |
String |
getValue()
Get the value of this setting. |
(package private) void |
initPermissions(int granted,
int denied)
Add permissions granted to Item.SETTING . |
void |
setName(String name)
Set the name for this setting. |
void |
setValue(String value)
Set the value for this setting. |
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 |
Methods inherited from interface net.sf.basedb.core.Identifiable |
---|
getType |
Field Detail |
---|
public static final Item TYPE
Item.SETTING
,
Identifiable.getType()
public static final int MAX_NAME_LENGTH
setName(String)
method to avoid exceptions.
public static final int MAX_VALUE_LENGTH
setValue(String)
method to avoid exceptions.
Constructor Detail |
---|
Setting(D settingData)
Method Detail |
---|
public static Setting getById(DbControl dc, int id) throws ItemNotFoundException, PermissionDeniedException, BaseException
Setting
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
Setting
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 errorvoid initPermissions(int granted, int denied) throws BaseException
Item.SETTING
.
initPermissions
in class BasicItem<D extends SettingData>
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 String getName()
public void setName(String name) throws PermissionDeniedException, InvalidDataException
name
- Name to be set.
PermissionDeniedException
- If the logged in user doesn't have
write permission
InvalidDataException
- If the new name is longer than
MAX_NAME_LENGTH
public String getValue()
public void setValue(String value) throws PermissionDeniedException, InvalidDataException
value
- The string value to be set. Can not be longer then 65535
PermissionDeniedException
- If the logged in user doesn't have
write permission
InvalidDataException
- If the new value is longer than
MAX_VALUE_LENGTH
|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |