Package org.xwiki.livedata.rest
Interface LiveDataEntriesResource
public interface LiveDataEntriesResource
Provides the list of entries from an existing
LiveDataSource
.- Since:
- 12.10
- Version:
- $Id: bc13a295c7511c0d74c143022a061277e9de0cb4 $
-
Method Summary
Modifier and TypeMethodDescriptionjavax.ws.rs.core.Response
Adds the given entry to the specified live data source.getEntries
(String sourceId, String namespace, List<String> properties, List<String> matchAll, List<String> sort, List<Boolean> descending, long offset, int limit) Provides the list of live data entries.
-
Method Details
-
getEntries
Entries getEntries(String sourceId, String namespace, List<String> properties, List<String> matchAll, List<String> sort, List<Boolean> descending, long offset, int limit) throws Exception Provides the list of live data entries. Here's an example URL:/liveData/sources/liveTable/entries? namespace=wiki%3Axwiki& sourceParams.className=Help.Applications.Movies.Code.MoviesClass& sourceParams.translationPrefix=movies.livetable.& properties=doc.title& properties=genre& properties=releaseDate& properties=director& properties=_actions& filters.doc.title=contains%3Amee& matchAll=doc.title& sort=releaseDate& descending=false& offset=0& limit=10
- 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 usedproperties
- the list of properties to include in the returned live data entriesmatchAll
- the list of properties for which to match all filter constraintssort
- the list of properties to sort ondescending
- indicates the sort direction for the properties specified by thesort
parameteroffset
- the index of the first entry to returnlimit
- the maximum number of entries to return- Returns:
- the list of live data entries that match the query
- Throws:
Exception
- if retrieving the live data entries fails
-
addEntry
Adds the given entry to 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 usedentry
- the entry to add- Returns:
- the response
- Throws:
Exception
- if adding the entry fails
-