Package org.xwiki.livedata.rest

Interface LiveDataPropertyResource

public interface LiveDataPropertyResource

Represents a live data property.

Since:

12.10

Version:

$Id: d07bc4cf8a59fe35d9dfd0f88fe174444beb8da5 $

Method Summary

Modifier and Type	Method	Description
void	deleteProperty(String sourceId, String namespace, String propertyId)	Deletes a live data property.
PropertyDescriptor	getProperty(String sourceId, String namespace, String propertyId)	Provides information about a live data property.
javax.ws.rs.core.Response	updateProperty(String sourceId, String namespace, String propertyId, PropertyDescriptor propertyDescriptor)	Updates the descriptor of a live data property.

Method Detail

getProperty

PropertyDescriptor getProperty(String sourceId,
                               String namespace,
                               String propertyId)
                        throws Exception

Provides information about a live data property.

Parameters:

sourceId - indicates the LiveDataSource component implementation

namespace - the component manager name-space where to look for LiveDataSource implementations; if not specified then the context / current name-space is used

propertyId - identifies the live data property

Returns:

the descriptor of the specified live data property

Throws:

Exception - if retrieving the property fails

updateProperty

javax.ws.rs.core.Response updateProperty(String sourceId,
                                         String namespace,
                                         String propertyId,
                                         PropertyDescriptor propertyDescriptor)
                                  throws Exception

Updates the descriptor of a live data property.

Parameters:

sourceId - indicates the LiveDataSource component implementation

namespace - the component manager name-space where to look for LiveDataSource implementations; if not specified then the context / current name-space is used

propertyId - identifies the live data property to update

propertyDescriptor - the updated descriptor of the specified property

Returns:

the response

Throws:

Exception - if updating the property fails

deleteProperty

void deleteProperty(String sourceId,
                    String namespace,
                    String propertyId)
             throws Exception

Deletes a live data property.

Parameters:

sourceId - indicates the LiveDataSource component implementation

namespace - the component manager name-space where to look for LiveDataSource implementations; if not specified then the context / current name-space is used

propertyId - identifies the live data property to delete

Throws:

Exception - if deleting the specified property fails