Package de.tracetronic.jenkins.plugins.ecutest.wrapper.com

Class AbstractTestObject

java.lang.Object

com.jacob.com.JacobObject

com.jacob.com.Dispatch

de.tracetronic.jenkins.plugins.ecutest.wrapper.com.ETComDispatch

de.tracetronic.jenkins.plugins.ecutest.wrapper.com.AbstractTestObject

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

Constant, Package, Project

public abstract class AbstractTestObject
extends ETComDispatch

Common base class for Package and Project giving access to their properties.

Field Summary

Fields inherited from class com.jacob.com.Dispatch

fdexNameCaseSensitive, Get, LOCALE_SYSTEM_DEFAULT, m_pDispatch, Method, Put, PutRef

Constructor Summary

Constructors

Constructor	Description
AbstractTestObject(com.jacob.com.Dispatch dispatch, boolean useTimeout)	Instantiates a new AbstractTestObject.

Method Summary

Modifier and Type	Method	Description
List<AbstractTestClient.CheckInfoHolder>	check()	Returns a list of the errors of the project.
String	checkNG()	Returns converted error descriptions into specific Warnings NG plugin JSON format.
abstract String	getDescription()	Queries the test object description.
String	getName()	Queries the test object name.

Methods inherited from class de.tracetronic.jenkins.plugins.ecutest.wrapper.com.ETComDispatch

close, finalize, isAttached, performDirectRequest, performDirectRequest, performRequest, performRequest, performRequest, performRequest, useTimeout

Methods inherited from class com.jacob.com.Dispatch

call, call, call, call, callN, callN, callN_CaseSensitive, callSub, callSub, callSub, callSub, callSubN, callSubN, coCreateInstance, get, get, get_CaseSensitive, getActiveInstance, getIDOfName, getIDsOfNames, getIDsOfNames, getProgramId, hasExited, hasExited, invoke, invoke, invoke, invokeSub, invokeSub, invokeSub, invokeSubv, invokeSubv, invokeSubv, invokev, invokev, invokev, invokev, put, put, put_Casesensitive, putRef, putRef, QueryInterface, safeRelease

Methods inherited from class com.jacob.com.JacobObject

debug, getBuildDate, getBuildVersion, isDebugEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTestObject

public AbstractTestObject(com.jacob.com.Dispatch dispatch,
                          boolean useTimeout)

Instantiates a new AbstractTestObject.

This constructor is used instead of a case operation to turn a Dispatch object into a wider object - it must exist in every wrapper class whose instances may be returned from method calls wrapped in VT_DISPATCH Variants.

Parameters:

dispatch - the dispatch

useTimeout - specifies whether to apply timeout

Method Detail

getName

public String getName()
               throws ETComException

Queries the test object name.

Returns:

the name of this test object

Throws:

ETComException - in case of a COM exception

getDescription

public abstract String getDescription()
                               throws ETComException

Queries the test object description.

Returns:

the description of this test object

Throws:

ETComException - in case of a COM exception

check

public List<AbstractTestClient.CheckInfoHolder> check()
                                               throws ETComException

Returns a list of the errors of the project.

Returns:

the error list

Throws:

ETComException - in case of a COM exception

checkNG

public String checkNG()
               throws ETComException

Returns converted error descriptions into specific Warnings NG plugin JSON format.

Returns:

the error descriptions as issues in JSON format

Throws:

ETComException - in case of a COM exception