org.millstone.base.data
Interface Item

All Known Implementing Classes:

FilesystemContainer.FileItem, Form, PropertysetItem

public interface Item

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

Since:

3.0

Version:

3.0.3

Author:

IT Mill Ltd

Nested Class Summary

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.Managed 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

boolean	addItemProperty(java.lang.Object id, Property property) Tries to add a new Property into the Item.
Property	getItemProperty(java.lang.Object id) Gets the Property corresponding to the given Property ID stored in the Item.
java.util.Collection	getItemPropertyIds() Gets the collection of IDs of all Properties stored in the Item.
boolean	removeItemProperty(java.lang.Object id) Removes the Property identified by ID from the Item.

Method Detail

getItemProperty

public Property getItemProperty(java.lang.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

public java.util.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

public boolean addItemProperty(java.lang.Object id,
                               Property property)
                        throws java.lang.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 id

Returns:

true if the operation succeeded, false if not

Throws:

java.lang.UnsupportedOperationException - if the operation is not supported.

removeItemProperty

public boolean removeItemProperty(java.lang.Object id)
                           throws java.lang.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 false if not

Throws:

java.lang.UnsupportedOperationException - if the operation is not supported.