Package org.xwiki.livedata.rest

Interface LiveDataEntryPropertyResource

public interface LiveDataEntryPropertyResource

Represents a property of a live data entry.

Since:

12.10

Version:

$Id: 6110aa31bc6f51d8c15b1b8df15db1aa22306bd6 $

Method Summary

Modifier and Type	Method	Description
Object	getProperty(String sourceId, String namespace, String entryId, String propertyId)	Retrieves the value of a property from a specified live data entry.
javax.ws.rs.core.Response	setProperty(String sourceId, String namespace, String entryId, String propertyId, String value)	Sets the value of a property from a live data entry.

Method Detail

getProperty

Object getProperty(String sourceId,
                   String namespace,
                   String entryId,
                   String propertyId)
            throws Exception

Retrieves the value of a property from a specified live data entry.

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

entryId - identifies the live data entry

propertyId - identifies the property whose value to return

Returns:

the value of the specified property

Throws:

Exception - if retrieving the property value fails

setProperty

javax.ws.rs.core.Response setProperty(String sourceId,
                                      String namespace,
                                      String entryId,
                                      String propertyId,
                                      String value)
                               throws Exception

Sets the value of a property from a live data entry.

Parameters:

sourceId - indicates the LiveDataSource component implementation whose entry needs to be updated

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

entryId - identifies the live data entry whose property needs to be set

propertyId - identifies the property whose value needs to be set

value - the new property value

Returns:

the response

Throws:

Exception - if settings the property value fails