org.xwiki.livedata.rest

Interface LiveDataEntryResource

@Unstable
public interface LiveDataEntryResource

Represents a live data entry.

Since:

12.10

Version:

$Id: 9724e8b84085e6be4b22e70b7406978684922520 $

Method Summary

Modifier and Type	Method and Description
void	deleteEntry(String sourceId, String namespace, String entryId) Deletes an entry from the data set.
Entry	getEntry(String sourceId, String namespace, String entryId) Fetches an entry from the specified live data source.
javax.ws.rs.core.Response	updateEntry(String sourceId, String namespace, String entryId, Entry entry) Updates an existing entry.

Method Detail

getEntry

Entry getEntry(String sourceId,
               String namespace,
               String entryId)
        throws Exception

Fetches an entry from the specified live data source.

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 entry to retrieve

Returns:

the specified entry

Throws:

Exception - if retrieving the entry fails

updateEntry

javax.ws.rs.core.Response updateEntry(String sourceId,
                                      String namespace,
                                      String entryId,
                                      Entry entry)
                               throws Exception

Updates an existing 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

entry - the new entry values

entryId - identifies the entry to update

Returns:

the response

Throws:

Exception - if updating the specified entry fails

deleteEntry

void deleteEntry(String sourceId,
                 String namespace,
                 String entryId)
          throws Exception

Deletes an entry from the data set.

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 entry to delete

Throws:

Exception - if deleting the specified entry fails