Package net.solarnetwork.service

Interface Identifiable

All Known Subinterfaces:
DatumFilterService, ExpressionService, ObjectCodec, ObjectDecoder, ObjectEncoder, ResourceStorageService, TemporalRangesTariffEvaluator
All Known Implementing Classes:
BasicIdentifiable, SimpleTemporalRangesTariffEvaluator
public interface Identifiable
API for a standardized way of identifying services, to support configuring links to specific instances of a service at runtime. Many managed services in SolarNode allow any number of them to be deployed.
Version:
1.1
Author:
matt

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    GROUP_UID_PROPERTY
    A string group UID property, for use in events and other data structures.
    static final String
    UID_PROPERTY
    A string UID property, for use in events and other data structures.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDisplayName()
    Get a friendly display name for this service.
    String
    getGroupUid()
    Get a grouping identifier for this service.
    String
    getUid()
    Get a unique identifier for this service.

  • Field Details

    • UID_PROPERTY

      static final String UID_PROPERTY
      A string UID property, for use in events and other data structures.
      Since:
      1.1
      See Also:

    • GROUP_UID_PROPERTY

      static final String GROUP_UID_PROPERTY
      A string group UID property, for use in events and other data structures.
      Since:
      1.1
      See Also:

  • Method Details

    • getUid

      String getUid()
      Get a unique identifier for this service.

      This should be meaningful to the service implementation, and should be minimally unique between instances of the same service interface.

      Returns:
      unique identifier (should never be null)

    • getGroupUid

      String getGroupUid()
      Get a grouping identifier for this service.

      This should be meaningful to the service implementation.

      Returns:
      a group identifier, or null if not part of any group

    • getDisplayName

      String getDisplayName()
      Get a friendly display name for this service.
      Returns:
      a display name