Package net.solarnetwork.central.biz

Interface UserMetadataBiz

All Known Implementing Classes:
DaoUserMetadataBiz
public interface UserMetadataBiz
API for manipulating user metadata.
Since:
1.23

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addUserMetadata(Long userId, net.solarnetwork.domain.datum.GeneralDatumMetadata meta)
    Add metadata to a specific user.
    net.solarnetwork.dao.FilterResults<UserMetadataEntity,Long>
    findUserMetadata(UserMetadataFilter criteria, List<net.solarnetwork.domain.SortDescriptor> sortDescriptors, Integer offset, Integer max)
    Search for user metadata.
    void
    removeUserMetadata(Long userId)
    Remove all metadata to a specific user.
    void
    storeUserMetadata(Long userId, net.solarnetwork.domain.datum.GeneralDatumMetadata meta)
    Store metadata to a specific user, replacing any existing metadata with the provided metadata.

  • Method Details

    • addUserMetadata

      void addUserMetadata(Long userId, net.solarnetwork.domain.datum.GeneralDatumMetadata meta)
      Add metadata to a specific user. If metadata already exists for the given user, the values will be merged such that tags are added and info values are added or updated.
      Parameters:
      userId - the user ID to add to
      meta - the metadata to add

    • storeUserMetadata

      void storeUserMetadata(Long userId, net.solarnetwork.domain.datum.GeneralDatumMetadata meta)
      Store metadata to a specific user, replacing any existing metadata with the provided metadata.
      Parameters:
      userId - the user ID to add to
      meta - the metadata to store

    • removeUserMetadata

      void removeUserMetadata(Long userId)
      Remove all metadata to a specific user.
      Parameters:
      userId - the user ID to remove from

    • findUserMetadata

      net.solarnetwork.dao.FilterResults<UserMetadataEntity,Long> findUserMetadata(UserMetadataFilter criteria, List<net.solarnetwork.domain.SortDescriptor> sortDescriptors, Integer offset, Integer max)
      Search for user metadata.
      Parameters:
      criteria - the search criteria
      sortDescriptors - the optional sort descriptors
      offset - an optional result offset
      max - an optional maximum number of returned results
      Returns:
      the results, never null