Class SystemObjectInfo


  • public class SystemObjectInfo
    extends java.lang.Object
    Klasse zum Zugriff auf beschreibende Informationen von Systemobjekten.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static SystemObjectInfo UNDEFINED
      der undefinierte Zustand dieses Info-Objekts
    • Constructor Summary

      Constructors 
      Constructor Description
      SystemObjectInfo​(java.lang.String shortInfo, java.lang.String description)
      Initialisiert ein neues Info-Objekt mit beschreibenden Informationen eines Systemobjekts.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Lieferte eine ausführliche Beschreibung des jeweiligen Systemobjekts zurück, die HTML konform ist.
      java.lang.String getDescriptionAsMarkdown()
      Lieferte eine ausführliche Beschreibung des jeweiligen Systemobjekts zurück, die in Markdown formatiert ist.
      java.lang.String getDescriptionAsXML()
      Liefert die ausführliche Beschreibung des jeweiligen Systemobjekts zurück, wie sie in der Versorgungsdatei steht.
      java.lang.String getShortInfo()
      Lieferte eine kurze beschreibende Information des jeweiligen Systemobjekts zurück, die HTML konform ist.
      java.lang.String getShortInfoAsMarkdown()
      Lieferte eine kurze beschreibende Information des jeweiligen Systemobjekts zurück, die in Markdown formatiert ist.
      java.lang.String getShortInfoAsXML()
      Liefert die Kurzinformation des jeweiligen Systemobjekts zurück, wie sie in der Versorgungsdatei steht.
      java.lang.String toString()
      String-Repräsentation dieses Objekts.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • UNDEFINED

        public static final SystemObjectInfo UNDEFINED
        der undefinierte Zustand dieses Info-Objekts
    • Constructor Detail

      • SystemObjectInfo

        public SystemObjectInfo​(java.lang.String shortInfo,
                                java.lang.String description)
        Initialisiert ein neues Info-Objekt mit beschreibenden Informationen eines Systemobjekts.
        Parameters:
        shortInfo - Kurze beschreibende Information des jeweiligen Systemobjekts.
        description - Ausführliche Beschreibung des jeweiligen Systemobjekts.
    • Method Detail

      • getShortInfo

        public java.lang.String getShortInfo()
        Lieferte eine kurze beschreibende Information des jeweiligen Systemobjekts zurück, die HTML konform ist.
        Returns:
        HTML konformer Text, der die Kurzbeschreibung enthält. Ist keine Beschreibung vorhanden, wird ein leerer String "" zurückgegeben.
      • getShortInfoAsMarkdown

        public java.lang.String getShortInfoAsMarkdown()
        Lieferte eine kurze beschreibende Information des jeweiligen Systemobjekts zurück, die in Markdown formatiert ist.
        Returns:
        Markdown konformer Text, der die Kurzbeschreibung enthält. Ist keine Beschreibung vorhanden, wird ein leerer String "" zurückgegeben.
      • getDescription

        public java.lang.String getDescription()
        Lieferte eine ausführliche Beschreibung des jeweiligen Systemobjekts zurück, die HTML konform ist.
        Returns:
        HTML konformer Text, der die ausführliche Beschreibung enthält. Ist keine Beschreibung vorhanden, wird ein leerer String "" zurückgegeben.
      • getDescriptionAsMarkdown

        public java.lang.String getDescriptionAsMarkdown()
        Lieferte eine ausführliche Beschreibung des jeweiligen Systemobjekts zurück, die in Markdown formatiert ist.
        Returns:
        Markdown konformer Text, der die ausführliche Beschreibung enthält. Ist keine Beschreibung vorhanden, wird ein leerer String "" zurückgegeben.
      • getShortInfoAsXML

        public java.lang.String getShortInfoAsXML()
        Liefert die Kurzinformation des jeweiligen Systemobjekts zurück, wie sie in der Versorgungsdatei steht. Die Formatierung entspricht der K2S.DTD.
        Returns:
        Originaltext der Kurzinformation des jeweiligen Systemobjekts aus der Versorgungsdatei
      • getDescriptionAsXML

        public java.lang.String getDescriptionAsXML()
        Liefert die ausführliche Beschreibung des jeweiligen Systemobjekts zurück, wie sie in der Versorgungsdatei steht. Die Formatierung entspricht der K2S.DTD.
        Returns:
        Originaltext der Beschreibung des jeweiligen Systemobjekts aus der Versorgungsdatei
      • toString

        public java.lang.String toString()
        String-Repräsentation dieses Objekts. Enthält die Kurzinformation und die ausführliche Beschreibung.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String-Repräsentation dieses Objekts
        See Also:
        getShortInfo(), getDescription()