public class SystemObjectInfo
extends java.lang.Object
Klasse zum Zugriff auf beschreibende Informationen von Systemobjekten.
puk.configuration
Modifier and Type | Field and Description |
---|---|
static SystemObjectInfo |
UNDEFINED
der undefinierte Zustand dieses Info-Objekts
|
Constructor and Description |
---|
SystemObjectInfo(java.lang.String shortInfo,
java.lang.String description)
Initialisiert ein neues Info-Objekt mit beschreibenden Informationen eines Systemobjekts.
|
Modifier and Type | Method and 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.
|
public static final SystemObjectInfo UNDEFINED
der undefinierte Zustand dieses Info-Objekts
public SystemObjectInfo(java.lang.String shortInfo, java.lang.String description)
Initialisiert ein neues Info-Objekt mit beschreibenden Informationen eines Systemobjekts.
shortInfo
- Kurze beschreibende Information des jeweiligen Systemobjekts.description
- Ausführliche Beschreibung des jeweiligen Systemobjekts.public java.lang.String getShortInfo()
Lieferte eine kurze beschreibende Information des jeweiligen Systemobjekts zurück, die HTML
konform ist.
HTML
konformer Text, der die Kurzbeschreibung enthält. Ist keine Beschreibung vorhanden, wird ein leerer String ""
zurückgegeben.public java.lang.String getShortInfoAsMarkdown()
Lieferte eine kurze beschreibende Information des jeweiligen Systemobjekts zurück, die in Markdown
formatiert ist.
Markdown
konformer Text, der die Kurzbeschreibung enthält. Ist keine Beschreibung vorhanden, wird ein leerer String ""
zurückgegeben.public java.lang.String getDescription()
Lieferte eine ausführliche Beschreibung des jeweiligen Systemobjekts zurück, die HTML
konform ist.
HTML
konformer Text, der die ausführliche Beschreibung enthält. Ist keine Beschreibung vorhanden, wird ein leerer String ""
zurückgegeben.public java.lang.String getDescriptionAsMarkdown()
Lieferte eine ausführliche Beschreibung des jeweiligen Systemobjekts zurück, die in Markdown
formatiert ist.
Markdown
konformer Text, der die ausführliche Beschreibung enthält. Ist keine Beschreibung vorhanden, wird ein leerer String ""
zurückgegeben.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.
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.
public java.lang.String toString()
String-Repräsentation dieses Objekts. Enthält die Kurzinformation und die ausführliche Beschreibung.
toString
in class java.lang.Object
getShortInfo()
,
getDescription()