Decision Center API

ilog.rules.teamserver.brm
Interface IlrScenarioSuiteReport

All Superinterfaces:
Cloneable, IlrBasicModelElement, ilog.rules.teamserver.model.IlrCompositeObject, ilog.rules.commonbrm.model.IlrElement, IlrElementDetails, IlrElementHandle, IlrElementSummary, IlrModelElement, Serializable

public interface IlrScenarioSuiteReport
extends IlrModelElement

A representation of the model object 'Scenario Suite Report'.

The following features are supported:

See Also:
IlrBrmPackage.getScenarioSuiteReport()

Method Summary
 IlrBaseline getBranch()
          Returns the value of the 'Branch' reference.
 String getExecutedBy()
          Returns the value of the 'Executed By' attribute.
 int getNbErrors()
          Returns the value of the 'Nb Errors' attribute.
 int getNbFailures()
          Returns the value of the 'Nb Failures' attribute.
 int getNbScenarios()
          Returns the value of the 'Nb Scenarios' attribute.
 List getOptions()
          Returns the value of the 'Options' attribute list.
 IlrRuleProject getProject()
          Returns the value of the 'Project' reference.
 String getRunBaseline()
          Returns the value of the 'Run Baseline' attribute.
 String getScenarioSuiteFQN()
          Returns the value of the 'Scenario Suite FQN' attribute.
 int getScenarioSuiteID()
          Returns the value of the 'Scenario Suite ID' attribute.
 List getScenarioSuiteKPIReports()
          Returns the value of the 'Scenario Suite KPI Reports' containment reference list.
 List getScenarioSuiteKPIReports(IlrElementVersion version)
          Returns the value of the 'Scenario Suite KPI Reports' containment reference list for the given version.
 int getScenarioSuiteOID()
          Returns the value of the 'Scenario Suite OID' attribute.
 List getScenarioTestReports()
          Returns the value of the 'Scenario Test Reports' containment reference list.
 List getScenarioTestReports(IlrElementVersion version)
          Returns the value of the 'Scenario Test Reports' containment reference list for the given version.
 String getServerName()
          Returns the value of the 'Server Name' attribute.
 List getTestReports()
          Returns the value of the 'Test Reports' containment reference list.
 List getTestReports(IlrElementVersion version)
          Returns the value of the 'Test Reports' containment reference list for the given version.
 boolean isArchiveErrors()
          Returns the value of the 'Archive Errors' attribute.
 boolean isArchiveWarnings()
          Returns the value of the 'Archive Warnings' attribute.
 
Methods inherited from interface ilog.rules.teamserver.brm.IlrModelElement
getName, getUuid
 
Methods inherited from interface ilog.rules.teamserver.brm.IlrBasicModelElement
getCreatedBy, getCreatedOn, getLastChangedBy, getLastChangedOn
 
Methods inherited from interface ilog.rules.teamserver.model.IlrElementDetails
cloneElement, getContainer, getRawValue, setRawValue, setRawValueNoCheck
 
Methods inherited from interface ilog.rules.teamserver.model.IlrElementHandle
eClass, equals, equals, getModelInfo, getSession, getType, getValue, hashCode, isNew, toIdString
 
Methods inherited from interface ilog.rules.commonbrm.model.IlrElement
getPropertyValue, getPropertyValue, isInstanceOf
 

Method Detail

getProject

IlrRuleProject getProject()
                          throws IlrObjectNotFoundException
Returns the value of the 'Project' reference.

Throws:
IlrObjectNotFoundException
Returns:
the value of the 'Project' reference.
See Also:
IlrBrmPackage.getScenarioSuiteReport_Project()

getBranch

IlrBaseline getBranch()
                      throws IlrObjectNotFoundException
Returns the value of the 'Branch' reference.

If the meaning of the 'Branch' reference isn't clear, there really should be more of a description here...

Throws:
IlrObjectNotFoundException
Returns:
the value of the 'Branch' reference.
See Also:
IlrBrmPackage.getScenarioSuiteReport_Branch()

getScenarioSuiteID

int getScenarioSuiteID()
Returns the value of the 'Scenario Suite ID' attribute.

Returns:
the value of the 'Scenario Suite ID' attribute.
See Also:
IlrBrmPackage.getScenarioSuiteReport_ScenarioSuiteID()

getScenarioSuiteOID

int getScenarioSuiteOID()
Returns the value of the 'Scenario Suite OID' attribute.

Returns:
the value of the 'Scenario Suite OID' attribute.
See Also:
IlrBrmPackage.getScenarioSuiteReport_ScenarioSuiteOID()

getScenarioSuiteFQN

String getScenarioSuiteFQN()
Returns the value of the 'Scenario Suite FQN' attribute.

Returns:
the value of the 'Scenario Suite FQN' attribute.
See Also:
IlrBrmPackage.getScenarioSuiteReport_ScenarioSuiteFQN()

getServerName

String getServerName()
Returns the value of the 'Server Name' attribute.

If the meaning of the 'Server Name' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Server Name' attribute.
See Also:
IlrBrmPackage.getScenarioSuiteReport_ServerName()

getRunBaseline

String getRunBaseline()
Returns the value of the 'Run Baseline' attribute.

Returns:
the value of the 'Run Baseline' attribute.
See Also:
IlrBrmPackage.getScenarioSuiteReport_RunBaseline()

getTestReports

List getTestReports()
                    throws IlrObjectNotFoundException
Returns the value of the 'Test Reports' containment reference list.

The list contents are of type IlrTestReport.

Throws:
IlrObjectNotFoundException
Returns:
the value of the 'Test Reports' containment reference list.
See Also:
IlrBrmPackage.getScenarioSuiteReport_TestReports()

getTestReports

List getTestReports(IlrElementVersion version)
                    throws IlrObjectNotFoundException
Returns the value of the 'Test Reports' containment reference list for the given version. Allows to retrieve the value linked to a specific version. Useful when the working baseline is the current baseline.

The list contents are of type IlrTestReport.

Throws:
IlrObjectNotFoundException
Parameters:
version - The version of the element.
Returns:
the value of the 'Test Reports' containment reference list.
See Also:
IlrBrmPackage.getScenarioSuiteReport_TestReports()

getScenarioSuiteKPIReports

List getScenarioSuiteKPIReports()
                                throws IlrObjectNotFoundException
Returns the value of the 'Scenario Suite KPI Reports' containment reference list.

The list contents are of type IlrScenarioSuiteKPIReport.

Throws:
IlrObjectNotFoundException
Returns:
the value of the 'Scenario Suite KPI Reports' containment reference list.
See Also:
IlrBrmPackage.getScenarioSuiteReport_ScenarioSuiteKPIReports()

getScenarioSuiteKPIReports

List getScenarioSuiteKPIReports(IlrElementVersion version)
                                throws IlrObjectNotFoundException
Returns the value of the 'Scenario Suite KPI Reports' containment reference list for the given version. Allows to retrieve the value linked to a specific version. Useful when the working baseline is the current baseline.

The list contents are of type IlrScenarioSuiteKPIReport.

Throws:
IlrObjectNotFoundException
Parameters:
version - The version of the element.
Returns:
the value of the 'Scenario Suite KPI Reports' containment reference list.
See Also:
IlrBrmPackage.getScenarioSuiteReport_ScenarioSuiteKPIReports()

getScenarioTestReports

List getScenarioTestReports()
                            throws IlrObjectNotFoundException
Returns the value of the 'Scenario Test Reports' containment reference list.

The list contents are of type IlrScenarioTestReport.

Throws:
IlrObjectNotFoundException
Returns:
the value of the 'Scenario Test Reports' containment reference list.
See Also:
IlrBrmPackage.getScenarioSuiteReport_ScenarioTestReports()

getScenarioTestReports

List getScenarioTestReports(IlrElementVersion version)
                            throws IlrObjectNotFoundException
Returns the value of the 'Scenario Test Reports' containment reference list for the given version. Allows to retrieve the value linked to a specific version. Useful when the working baseline is the current baseline.

The list contents are of type IlrScenarioTestReport.

Throws:
IlrObjectNotFoundException
Parameters:
version - The version of the element.
Returns:
the value of the 'Scenario Test Reports' containment reference list.
See Also:
IlrBrmPackage.getScenarioSuiteReport_ScenarioTestReports()

getExecutedBy

String getExecutedBy()
Returns the value of the 'Executed By' attribute.

Returns:
the value of the 'Executed By' attribute.
See Also:
IlrBrmPackage.getScenarioSuiteReport_ExecutedBy()

getOptions

List getOptions()
Returns the value of the 'Options' attribute list.

The list contents are of type String.

Returns:
the value of the 'Options' attribute list.
See Also:
IlrBrmPackage.getScenarioSuiteReport_Options()

getNbScenarios

int getNbScenarios()
Returns the value of the 'Nb Scenarios' attribute.

Returns:
the value of the 'Nb Scenarios' attribute.
See Also:
IlrBrmPackage.getScenarioSuiteReport_NbScenarios()

getNbFailures

int getNbFailures()
Returns the value of the 'Nb Failures' attribute.

Returns:
the value of the 'Nb Failures' attribute.
See Also:
IlrBrmPackage.getScenarioSuiteReport_NbFailures()

getNbErrors

int getNbErrors()
Returns the value of the 'Nb Errors' attribute.

Returns:
the value of the 'Nb Errors' attribute.
See Also:
IlrBrmPackage.getScenarioSuiteReport_NbErrors()

isArchiveWarnings

boolean isArchiveWarnings()
Returns the value of the 'Archive Warnings' attribute.

Returns:
the value of the 'Archive Warnings' attribute.
See Also:
IlrBrmPackage.getScenarioSuiteReport_ArchiveWarnings()

isArchiveErrors

boolean isArchiveErrors()
Returns the value of the 'Archive Errors' attribute.

Returns:
the value of the 'Archive Errors' attribute.
See Also:
IlrBrmPackage.getScenarioSuiteReport_ArchiveErrors()

Decision Center API

© Copyright IBM Corp. 1987, 2013