Package net.sf.basedb.core

Class Setting

java.lang.Object

net.sf.basedb.core.BasicItem

net.sf.basedb.core.Setting

All Implemented Interfaces:

AccessControlled, Identifiable

Direct Known Subclasses:

ClientDefaultSetting, GlobalDefaultSetting, UserClientSetting, UserDefaultSetting

public abstract class Setting
extends BasicItem

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.

Version:

2.0

Author:

Nicklas

Field Summary

Fields

Modifier and Type	Field	Description
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

Constructors

Constructor	Description
Setting(SettingData settingData)

Method Summary

Modifier and Type	Method	Description
static Setting	getById(DbControl dc, int id)	Get a Setting item when you know the ID.
(package private) SettingData	getData()	Get the BasicData object that holds all data for this item.
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

addAnnotatableParents, addUsingItems, addUsingItems, breakCircularReferences, checkBatchAnnotatableUsage, checkPermission, equals, getBasicData, getDbControl, getId, getPermissions, getPluginPermissions, getSessionControl, getUsingItems, getVersion, hashCode, hasPermission, isDetached, isInDatabase, isUsed, onAfterCommit, onAfterInsert, onBeforeCommit, onRollback, setDbControl, setProjectDefaults, toString, 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 Details

TYPE

public static final Item TYPE

The type of item represented by this class.

See Also:

Item.SETTING, Identifiable.getType()

MAX_NAME_LENGTH

public static final int MAX_NAME_LENGTH

The maximum length of the name that can be stored in the database. Check the length against this value before calling the setName(String) method to avoid exceptions.

See Also:

Constant Field Values

MAX_VALUE_LENGTH

public static final int MAX_VALUE_LENGTH

The maximum length of the value that can be stored in the database. Check the length against this value before calling the setValue(String) method to avoid exceptions.

See Also:

Constant Field Values

Constructor Details

Setting

Setting(SettingData settingData)

Method Details

getById

public static Setting getById(DbControl dc,
int id)
                       throws ItemNotFoundException,
PermissionDeniedException,
BaseException

Get a Setting item when you know the ID.

Parameters:

dc - The DbControl which will be used for permission checking and database access.

id - The ID of the item to load

Returns:

The Setting item

Throws:

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 error

getData

SettingData getData()

Description copied from class: BasicItem

Get the BasicData object that holds all data for this item.

Specified by:

getData in class BasicItem

initPermissions

void initPermissions(int granted,
int denied)
              throws BaseException

Add permissions granted to Item.SETTING.

Overrides:

initPermissions in class BasicItem

Parameters:

granted - Permissions that have been granted by the subclass

denied - Permissions that have been denied by the subclass

Throws:

BaseException - If the permissions couldn't be initialised

getName

public String getName()

Get the name of this setting.

Returns:

A String object.

setName

public void setName(String name)
             throws PermissionDeniedException,
InvalidDataException

Set the name for this setting.

Parameters:

name - Name to be set.

Throws:

PermissionDeniedException - If the logged in user doesn't have write permission

InvalidDataException - If the new name is longer than MAX_NAME_LENGTH

getValue

public String getValue()

Get the value of this setting.

Returns:

A String object.

setValue

public void setValue(String value)
              throws PermissionDeniedException,
InvalidDataException

Set the value for this setting.

Parameters:

value - The string value to be set. Can not be longer then 65535

Throws:

PermissionDeniedException - If the logged in user doesn't have write permission

InvalidDataException - If the new value is longer than MAX_VALUE_LENGTH