ch.agent.crnickl.api

Interface UpdatableValueType<T>

Type Parameters:

T - the underlying data type of the values

All Superinterfaces:

DBObject, Updatable, ValueType<T>

All Known Implementing Classes:

UpdatableValueTypeImpl

public interface UpdatableValueType<T>
extends ValueType<T>, Updatable

An UpdatableValueType is a value type which can be modified.

Author:

Jean-Paul Vetterli

Nested Class Summary

Nested classes/interfaces inherited from interface ch.agent.crnickl.api.ValueType

ValueType.StandardValueType

Method Summary

Modifier and Type	Method and Description
void	addValue(T value, String description) Add a value to list of allowed values.
void	deleteValue(T value) Delete a value from the list of allowed values.
void	destroy() Destroy the value type.
void	setName(String name) Set the name of the value type.
void	updateValue(T value, String description) Update the description of the given allowed value.

Methods inherited from interface ch.agent.crnickl.api.ValueType

check, edit, getExternalRepresentation, getName, getScanner, getStandardValueType, getType, getValueDescriptions, getValues, getValues, isBuiltIn, isCompatible, isRestricted, scan, toString, typeCheck

Methods inherited from interface ch.agent.crnickl.api.DBObject

getDatabase, getId, getSurrogate, inConstruction, isValid

Methods inherited from interface ch.agent.crnickl.api.Updatable

applyUpdates

Method Detail

setName

void setName(String name)
      throws T2DBException

Set the name of the value type.

Parameters:

name - a string

Throws:

T2DBException

addValue

void addValue(T value,
              String description)
       throws T2DBException

Add a value to list of allowed values. This method can only be used if the value type is restricted.

Parameters:

value - a value

description - the value's description

Throws:

T2DBException

updateValue

void updateValue(T value,
                 String description)
          throws T2DBException

Update the description of the given allowed value. This method can only be used if the value type is restricted.

Parameters:

value - an allowed value

description - a string

Throws:

T2DBException

deleteValue

void deleteValue(T value)
          throws T2DBException

Delete a value from the list of allowed values. This method can only be used if the value type is restricted. The operation fails if the value is in use, either as the default value of an attribute or as an actual attribute value.

Parameters:

value - the value to delete

Throws:

T2DBException

destroy

void destroy()
      throws T2DBException

Destroy the value type. The operation fails if the value type is in use.

Throws:

T2DBException