Package com.tccc.kos.commons.core.service.trouble

Interface HandleTroubleIface

All Superinterfaces:
TroubleIface
public interface HandleTroubleIface extends TroubleIface
Interface for Troubles that implements the handle iface. This is a standard way to describe to external systems that the Trouble includes path information in a standard format.

Implementations must call HandleTroubleIface.addIface(trouble) to ensure that external systems know the trouble implements this interface.

This indicates the handle interface is implemented and the following data is available:

  • path : Path to the associated handle object
Since:
1.0
Version:
2023-11-28

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    addIface(Trouble trouble)
    Adds the iface to the specified Trouble .
    String
    getPath()
    Returns the path of the associated handle object.

  • Method Details

    • addIface

      static void addIface(Trouble trouble)
      Adds the iface to the specified Trouble . Should be called in the Trouble constructor.
      Parameters:
      trouble - the Trouble to add the iface to

    • getPath

      String getPath()
      Returns the path of the associated handle object.