OTX-Runtime for Java  
OpenTestSystem.Otx.Runtime.Api.Otx.IDocument Interface Reference

Represents an OTX. More...

Public Member Functions

IContextVariable[] GetContextVariables ()
 Gets all ContextVariables. More...
 
String GetFullName ()
 Gets Document full name. More...
 
IDocument[] GetImports ()
 Gets all imported Documents. More...
 
IProcedure GetMainProcedure ()
 Gets main Procedure. More...
 
String GetName ()
 Gets Document name. More...
 
IPackage GetPackage ()
 Gets Package. More...
 
IProcedure[] GetProcedures ()
 Gets all Procedures. More...
 
ISignature[] GetSignatures ()
 Gets all Signatures. More...
 
String GetSpecification ()
 Gets Otx specification. More...
 
IStateVariable[] GetStateVariables ()
 Gets all StateVariables. More...
 
String GetVersion ()
 Gets Otx version. More...
 
boolean IsStartup ()
 Checks if the Document is the startup Document. More...
 

Detailed Description

Represents an OTX.

Member Function Documentation

◆ GetContextVariables()

IContextVariable [] OpenTestSystem.Otx.Runtime.Api.Otx.IDocument.GetContextVariables ( )

Gets all ContextVariables.

Returns
A list of ContextVariables.

◆ GetFullName()

String OpenTestSystem.Otx.Runtime.Api.Otx.IDocument.GetFullName ( )

Gets Document full name.

Returns
A combination of Package full name and Document name, separated by '.'.

◆ GetImports()

IDocument [] OpenTestSystem.Otx.Runtime.Api.Otx.IDocument.GetImports ( )

Gets all imported Documents.

An imported Documents can also contain Imports in an arbitrary depth depending on the OTX Document structure.

Returns
A list of imported Documents.

◆ GetMainProcedure()

IProcedure OpenTestSystem.Otx.Runtime.Api.Otx.IDocument.GetMainProcedure ( )

Gets main Procedure.

Returns
Main Procedure.

◆ GetName()

String OpenTestSystem.Otx.Runtime.Api.Otx.IDocument.GetName ( )

Gets Document name.

Returns
Document name.

◆ GetPackage()

IPackage OpenTestSystem.Otx.Runtime.Api.Otx.IDocument.GetPackage ( )

Gets Package.

Returns
A Package which this Document belongs to.

◆ GetProcedures()

IProcedure [] OpenTestSystem.Otx.Runtime.Api.Otx.IDocument.GetProcedures ( )

Gets all Procedures.

Returns
A list of Procedures.

◆ GetSignatures()

ISignature [] OpenTestSystem.Otx.Runtime.Api.Otx.IDocument.GetSignatures ( )

Gets all Signatures.

Returns
A list of Signatures.

◆ GetSpecification()

String OpenTestSystem.Otx.Runtime.Api.Otx.IDocument.GetSpecification ( )

Gets Otx specification.

Returns
Otx specification.

◆ GetStateVariables()

IStateVariable [] OpenTestSystem.Otx.Runtime.Api.Otx.IDocument.GetStateVariables ( )

Gets all StateVariables.

Returns
A list of StateVariables.

◆ GetVersion()

String OpenTestSystem.Otx.Runtime.Api.Otx.IDocument.GetVersion ( )

Gets Otx version.

Returns
Otx version.

◆ IsStartup()

boolean OpenTestSystem.Otx.Runtime.Api.Otx.IDocument.IsStartup ( )

Checks if the Document is the startup Document.

Returns
true if this document is startup; otherwise, false.

The documentation for this interface was generated from the following file: