Package com.uc4.api.objects

Class DocuContainer

java.lang.Object

com.uc4.api.objects.DocuContainer

public class DocuContainer
extends Object

This class represents the documentation tab of an Automation Engine object. It can contain text or structured (XML) documenation objects

Method Summary

Modifier and Type	Method	Description
String[]	getAllDocuNames()
String[]	getTextDocuNames()
String[]	getXmlDocuNames()
TextDocumentation	textDocumentation(String name)	This method provides access to the text documentation which the specified name.
XMLDocumentation	xmlDocumentation(String name)	This method provides access to the xml documentation which the specified name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

textDocumentation

public TextDocumentation textDocumentation(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(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 String[] getTextDocuNames()

Returns:

Array of Strings containing the names of all text documenations in this UC4 Object

getXmlDocuNames

public String[] getXmlDocuNames()

Returns:

Array of Strings containing the names of all xml documenations in this UC4 Object

getAllDocuNames

public String[] getAllDocuNames()

Returns:

Array of Strings containing the names of all documentations, xml and text, in this UC4 Object.