Package com.uc4.api.objects
Class DocuContainer
- java.lang.Object
-
- com.uc4.api.objects.DocuContainer
-
public class DocuContainer extends java.lang.Object
This class represents the documentation tab of an Automation Engine object. It can contain text or structured (XML) documenation objects
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String[]
getAllDocuNames()
java.lang.String[]
getTextDocuNames()
java.lang.String[]
getXmlDocuNames()
TextDocumentation
textDocumentation(java.lang.String name)
This method provides access to the text documentation which the specified name.XMLDocumentation
xmlDocumentation(java.lang.String name)
This method provides access to the xml documentation which the specified name.
-
-
-
Method Detail
-
textDocumentation
public TextDocumentation textDocumentation(java.lang.String name)
This method provides access to the text documentation which the specified name.- Parameters:
name
- Name of the documenation (Name of the tab in the User Interface)- Returns:
- TextDocumentation object or
null
if a documentation with the specified name was not found.
-
xmlDocumentation
public XMLDocumentation xmlDocumentation(java.lang.String name)
This method provides access to the xml documentation which the specified name.- Parameters:
name
- Name of the documenation (Name of the tab in the User Interface)- Returns:
- XMLDocumentation object or
null
if a documentation with the specified name was not found.
-
getTextDocuNames
public java.lang.String[] getTextDocuNames()
- Returns:
- Array of Strings containing the names of all text documenations in this UC4 Object
-
getXmlDocuNames
public java.lang.String[] getXmlDocuNames()
- Returns:
- Array of Strings containing the names of all xml documenations in this UC4 Object
-
getAllDocuNames
public java.lang.String[] getAllDocuNames()
- Returns:
- Array of Strings containing the names of all documentations, xml and text, in this UC4 Object.
-
-