Package com.vaadin.data

Interface Item

All Superinterfaces:

Serializable

All Known Implementing Classes:

BeanItem, FilesystemContainer.FileItem, Form, GeneratedPropertyContainer.GeneratedPropertyItem, PropertysetItem, RowItem

public interface Item
extends Serializable

Provides a mechanism for handling a set of Properties, each associated to a locally unique non-null identifier. The interface is split into subinterfaces to enable a class to implement only the functionalities it needs.

Since:

3.0

Author:

Vaadin Ltd

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Item.Editor	Interface implemented by the Editor classes capable of editing the Item.
static interface	Item.PropertySetChangeEvent	An Event object specifying the Item whose contents has been changed through the Property interface.
static interface	Item.PropertySetChangeListener	The listener interface for receiving PropertySetChangeEvent objects.
static interface	Item.PropertySetChangeNotifier	The interface for adding and removing PropertySetChangeEvent listeners.
static interface	Item.Viewer	Interface implemented by viewer classes capable of using an Item as a data source.

Method Summary

Modifier and Type	Method	Description
boolean	addItemProperty(Object id, Property property)	Tries to add a new Property into the Item.
Property	getItemProperty(Object id)	Gets the Property corresponding to the given Property ID stored in the Item.
Collection<?>	getItemPropertyIds()	Gets the collection of IDs of all Properties stored in the Item.
boolean	removeItemProperty(Object id)	Removes the Property identified by ID from the Item.

Method Detail

getItemProperty

Property getItemProperty(Object id)

Gets the Property corresponding to the given Property ID stored in the Item. If the Item does not contain the Property, null is returned.

Parameters:

id - identifier of the Property to get

Returns:

the Property with the given ID or null

getItemPropertyIds

Collection<?> getItemPropertyIds()

Gets the collection of IDs of all Properties stored in the Item.

Returns:

unmodifiable collection containing IDs of the Properties stored the Item

addItemProperty

boolean addItemProperty(Object id,
                        Property property)
                 throws UnsupportedOperationException

Tries to add a new Property into the Item.

This functionality is optional.

Parameters:

id - ID of the new Property

property - the Property to be added and associated with the id

Returns:

true if the operation succeeded, false if not

Throws:

UnsupportedOperationException - if the operation is not supported.

removeItemProperty

boolean removeItemProperty(Object id)
                    throws UnsupportedOperationException

Removes the Property identified by ID from the Item.

This functionality is optional.

Parameters:

id - ID of the Property to be removed

Returns:

true if the operation succeeded

Throws:

UnsupportedOperationException - if the operation is not supported. false if not