Package net.solarnetwork.central.domain

Interface SolarNodeOwnership

All Known Implementing Classes:
BasicSolarNodeOwnership
public interface SolarNodeOwnership
API for node ownership details.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCountry()
    Get the ISO 3166-1 alpha-2 character country code.
    Long
    getNodeId()
    Get the node ID.
    Long
    getUserId()
    Get the user ID of the owner of a node.
    ZoneId
    getZone()
    Get the node's time zone.
    boolean
    isArchived()
    Flag indicating if a node has been "archived".
    boolean
    isRequiresAuthorization()
    Flag indicating if a node's data is "public" vs "private".

  • Method Details

    • getNodeId

      @NonNull Long getNodeId()
      Get the node ID.
      Returns:
      the node ID

    • getUserId

      @NonNull Long getUserId()
      Get the user ID of the owner of a node.
      Returns:
      the owner user ID

    • getCountry

      String getCountry()
      Get the ISO 3166-1 alpha-2 character country code.
      Returns:
      2-character country code

    • getZone

      @NonNull ZoneId getZone()
      Get the node's time zone.
      Returns:
      the time zone

    • isRequiresAuthorization

      boolean isRequiresAuthorization()
      Flag indicating if a node's data is "public" vs "private".
      Returns:
      true if the node requires authorization for viewing its data

    • isArchived

      boolean isArchived()
      Flag indicating if a node has been "archived".
      Returns:
      true if the node has been archived