org.xwiki.livedata

Interface LiveDataPropertyDescriptorStore

@Role
 @Unstable
public interface LiveDataPropertyDescriptorStore

The interface used to store and retrieve the property descriptors.

Since:

12.10

Version:

$Id: f4bd9b41e92ff66fae2d5f8aa7f82becdab7a158 $

Method Summary

Modifier and Type	Method and Description
Collection<LiveDataPropertyDescriptor>	get()
default Optional<LiveDataPropertyDescriptor>	get(String propertyId)
default Optional<LiveDataPropertyDescriptor>	remove(String propertyId) Removes the specified property descriptor.
default boolean	save(LiveDataPropertyDescriptor propertyDescriptor) Adds a new property descriptor or updates an existing one.

Method Detail

get

default Optional<LiveDataPropertyDescriptor> get(String propertyId)
                                          throws LiveDataException

Parameters:

propertyId - identifies the property whose descriptor to return

Returns:

the descriptor of the specified property

Throws:

LiveDataException - if retrieving the property descriptor fails

get

Collection<LiveDataPropertyDescriptor> get()
                                    throws LiveDataException

Returns:

all property descriptors

Throws:

LiveDataException - if retrieving the property descriptors fails

save

default boolean save(LiveDataPropertyDescriptor propertyDescriptor)
              throws LiveDataException

Adds a new property descriptor or updates an existing one.

Parameters:

propertyDescriptor - the property descriptor to save

Returns:

true if the property descriptor was saved, false otherwise

Throws:

LiveDataException - if saving the property descriptor fails

remove

default Optional<LiveDataPropertyDescriptor> remove(String propertyId)
                                             throws LiveDataException

Removes the specified property descriptor.

Parameters:

propertyId - identifies the property whose descriptor to remove

Returns:

the removed property descriptor

Throws:

LiveDataException - if removing the property descriptor fails