Interface LiveDataEntryStore


  • @Role
    public interface LiveDataEntryStore
    The interface used to store and retrieve live data entries.
    Since:
    12.10
    Version:
    $Id: 5588e9fccfd218691962c1998225a59abfb21fe9 $
    • Method Detail

      • get

        default Optional<Object> get​(Object entryId,
                                     String property)
                              throws LiveDataException
        Parameters:
        entryId - identifies the entry whose property value to return
        property - the property whose value to return
        Returns:
        the value of the specified property from the specified live data entry
        Throws:
        LiveDataException - if retrieving the specified property fails
      • get

        LiveData get​(LiveDataQuery query)
              throws LiveDataException
        Executes a query on the live data.
        Parameters:
        query - the query used to filter and sort the live data entries
        Returns:
        the live data entries that match the given query
        Throws:
        LiveDataException - if the live data query execution fails
      • update

        default Optional<Object> update​(Object entryId,
                                        String property,
                                        Object value)
                                 throws LiveDataException
        Updates a property of a live data entry.
        Parameters:
        entryId - the entry to update
        property - the property to update
        value - the new property value
        Returns:
        the previous property value
        Throws:
        LiveDataException - if updating the specified property fails