Package org.xwiki.livedata.rest
Interface LiveDataEntryResource
public interface LiveDataEntryResource
Represents a live data entry.
- Since:
- 12.10
- Version:
- $Id: 7ee3e698e7dff8337fcc81609afe4caef582d83c $
-
Method Summary
Modifier and TypeMethodDescriptionvoid
deleteEntry
(String sourceId, String namespace, String entryId) Deletes an entry from the data set.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 Details
-
getEntry
Fetches an entry from the specified live data source.- Parameters:
sourceId
- indicates theLiveDataSource
component implementationnamespace
- the component manager name-space where to look forLiveDataSource
implementations; if not specified then the context / current name-space is usedentryId
- 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 theLiveDataSource
component implementationnamespace
- the component manager name-space where to look forLiveDataSource
implementations; if not specified then the context / current name-space is usedentry
- the new entry valuesentryId
- identifies the entry to update- Returns:
- the response
- Throws:
Exception
- if updating the specified entry fails
-
deleteEntry
Deletes an entry from the data set.- Parameters:
sourceId
- indicates theLiveDataSource
component implementationnamespace
- the component manager name-space where to look forLiveDataSource
implementations; if not specified then the context / current name-space is usedentryId
- identifies the entry to delete- Throws:
Exception
- if deleting the specified entry fails
-