com.im.df.api.ddl
Interface DFList

All Superinterfaces:

DFItem, DFUserItem, PropertiesEditingConfigurable

public interface DFList
extends DFUserItem

List of primary key values stored in the model.

Nested Class Summary

Nested classes/interfaces inherited from interface com.im.df.api.ddl.DFItem

DFItem.Handle<T extends DFItem>

Nested classes/interfaces inherited from interface com.im.df.api.support.PropertiesEditingConfigurable

PropertiesEditingConfigurable.Extra

Field Summary

static String

PROP_VALUES

Fields inherited from interface com.im.df.api.ddl.DFItem

PROP_CAPABILITIES, PROP_DESCRIPTION, PROP_ID, PROP_NAME, PROP_TYPE, PROP_VALID

Method Summary

DFEntity	getEntity() Get the entity which this list belongs to.
DFField	getField() Get the field associated with this list.
DFItem.Handle<DFList>	getHandle() Returns a handle to the Item.
List	getValues() Get the current list of values.
void	setValues(List values, DFEnvironmentRW env) Set new list of primary key values for this list.

Methods inherited from interface com.im.df.api.ddl.DFItem

addPropertyChangeListener, getCapabilities, getDescription, getId, getName, getType, isValid, removePropertyChangeListener, setDescription, setName

Methods inherited from interface com.im.df.api.support.PropertiesEditingConfigurable

isPropertyEditable

Field Detail

PROP_VALUES

static final String PROP_VALUES

See Also:

Constant Field Values

Method Detail

getEntity

DFEntity getEntity()

Get the entity which this list belongs to.

Returns:

The owner list

getField

DFField getField()

Get the field associated with this list.

Returns:

The associated field

getValues

List getValues()

Get the current list of values. There is no specific type of items in the returned list, but current known implementations always returns list of Integers.

Returns:

The list of primary key values

setValues

void setValues(List values,
               DFEnvironmentRW env)

Set new list of primary key values for this list. You can use it if you want to modify this persistent list of ids.

Parameters:

values - New list of ids.

env - The environment with appropriate lock

getHandle

DFItem.Handle<DFList> getHandle()

Description copied from interface: DFItem

Returns a handle to the Item. The handle uniquely identifies the Item, even though the schema data may be copied or otherwise replicated. Use the Handle instead of DFItem.getId() when registering an Item in collections that extend beyond the DFItem's parent Schema.

Specified by:

getHandle in interface DFItem

Returns:

The handle to the DFItem.