Package step.repository.alm.otaclient

Interface IComparison

All Superinterfaces:

com4j.Com4jObject, IBaseField, IBaseFieldEx, IObjectLockingSupport

public interface IComparison
extends IBaseFieldEx

For HP use. Represents a Comparison

Method Summary

Modifier and Type	Method	Description
void	compareBaselines(int oldBaselineId, int newBaselineId, IList comparisonSettingsList, com4j.Holder<IComparisonNode> pLeftRoot, com4j.Holder<IComparisonNode> pRightRoot)	Compare between two Baselines
IList	compareEntities(ILibraryInfo importerInfo, int importerBaseLineId, ILibraryInfo exportableInfo, int exportableBaselineId, IList comparisonSettingsList, int importedEntityId, int exportableEntityId, String compareEntityType)	Compares two entities of the same type that are mapped through libraries using a given set of comparison settings
void	compareLibraries(ILibraryInfo lv, int lComparedBaselineId, ILibraryInfo rv, int rComparedBaselineId, IList comparisonSettingsList, com4j.Holder<IComparisonNode> pLeftRoot, com4j.Holder<IComparisonNode> pRightRoot)	Compare between two Libraries.
IList	compareVersionedEntities(int entityID, int firstVersionId, int secondVersionId, IList comparisonSettingsList, String compareEntityType)	Compares two versions of entity using a given set of comparison settings
Date	creationDate()	The Date at which the comparison was created at
String	creatorUser()	The user name of the comparison's creator or importer.
IComparisonSettings	getComparisonSettings(String pType, IList fieldsList, boolean attachmentsNeeded, boolean richContentNeeded)	Get a single new Comparison Settings object for a specific given type
int	getComparisonStatistics(boolean isLeft, String folderEntityType, int comparisonChangeType)	Returns the count of a given comparison change type (Added/Moved/Modified/Removed) for a given entity folder type (e.g.
ILibraryInfo	leftEntityId()	The left entity which was compared.
IComparisonNode	leftRoot()	The left root of the comparison.
String	name()	The comparison's name
void	name(String pVal)	The comparison's name
ILibraryInfo	rightEntityId()	The right entity which was compared.
IComparisonNode	rightRoot()	The right root of the comparison.
int	state()	The state of the comparison process

Methods inherited from interface com4j.Com4jObject

advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

Methods inherited from interface step.repository.alm.otaclient.IBaseField

autoPost, autoPost, field, field, id, modified, post, refresh, undo, virtual

Methods inherited from interface step.repository.alm.otaclient.IBaseFieldEx

attachments, hasAttachment, history

Methods inherited from interface step.repository.alm.otaclient.IObjectLockingSupport

isLocked, lockObject, unLockObject

Method Detail

name

String name()

The comparison's name

Getter method for the COM property "Name"

Returns:

Returns a value of type java.lang.String

name

void name(String pVal)

The comparison's name

Setter method for the COM property "Name"

Parameters:

pVal - Mandatory java.lang.String parameter.

creatorUser

String creatorUser()

The user name of the comparison's creator or importer.

Getter method for the COM property "CreatorUser"

Returns:

Returns a value of type java.lang.String

creationDate

Date creationDate()

The Date at which the comparison was created at

Getter method for the COM property "CreationDate"

Returns:

Returns a value of type java.util.Date

leftEntityId

ILibraryInfo leftEntityId()

The left entity which was compared. This property returns null until the compare method is called

Getter method for the COM property "LeftEntityId"

Returns:

Returns a value of type otaclient.ILibraryInfo

rightEntityId

ILibraryInfo rightEntityId()

The right entity which was compared. This property returns null until the compare method is called

Getter method for the COM property "RightEntityId"

Returns:

Returns a value of type otaclient.ILibraryInfo

leftRoot

IComparisonNode leftRoot()

The left root of the comparison. This property returns null until the compare method returns

Getter method for the COM property "LeftRoot"

Returns:

Returns a value of type otaclient.IComparisonNode

rightRoot

IComparisonNode rightRoot()

The right root of the comparison. This property returns null until the compare method returns

Getter method for the COM property "RightRoot"

Returns:

Returns a value of type otaclient.IComparisonNode

state

int state()

The state of the comparison process

Getter method for the COM property "State"

Returns:

Returns a value of type int

compareLibraries

void compareLibraries(ILibraryInfo lv,
                      int lComparedBaselineId,
                      ILibraryInfo rv,
                      int rComparedBaselineId,
                      IList comparisonSettingsList,
                      com4j.Holder<IComparisonNode> pLeftRoot,
                      com4j.Holder<IComparisonNode> pRightRoot)

Compare between two Libraries. Always from current ((l/r)cComparedBaselineId == -1) of one library - to a specific (r/l)ComparedBaselineId of the other Library

Parameters:

lv - Mandatory otaclient.ILibraryInfo parameter.

lComparedBaselineId - Mandatory int parameter.

rv - Mandatory otaclient.ILibraryInfo parameter.

rComparedBaselineId - Mandatory int parameter.

comparisonSettingsList - Mandatory otaclient.IList parameter.

pLeftRoot - Mandatory Holder parameter.

pRightRoot - Mandatory Holder parameter.

compareBaselines

void compareBaselines(int oldBaselineId,
                      int newBaselineId,
                      IList comparisonSettingsList,
                      com4j.Holder<IComparisonNode> pLeftRoot,
                      com4j.Holder<IComparisonNode> pRightRoot)

Compare between two Baselines

Parameters:

oldBaselineId - Mandatory int parameter.

newBaselineId - Mandatory int parameter.

comparisonSettingsList - Mandatory otaclient.IList parameter.

pLeftRoot - Mandatory Holder parameter.

pRightRoot - Mandatory Holder parameter.

getComparisonSettings

IComparisonSettings getComparisonSettings(String pType,
                                          IList fieldsList,
                                          boolean attachmentsNeeded,
                                          boolean richContentNeeded)

Get a single new Comparison Settings object for a specific given type

Parameters:

pType - Mandatory java.lang.String parameter.

fieldsList - Mandatory otaclient.IList parameter.

attachmentsNeeded - Mandatory boolean parameter.

richContentNeeded - Mandatory boolean parameter.

Returns:

Returns a value of type otaclient.IComparisonSettings

compareEntities

IList compareEntities(ILibraryInfo importerInfo,
                      int importerBaseLineId,
                      ILibraryInfo exportableInfo,
                      int exportableBaselineId,
                      IList comparisonSettingsList,
                      int importedEntityId,
                      int exportableEntityId,
                      String compareEntityType)

Compares two entities of the same type that are mapped through libraries using a given set of comparison settings

Parameters:

importerInfo - Mandatory otaclient.ILibraryInfo parameter.

importerBaseLineId - Mandatory int parameter.

exportableInfo - Mandatory otaclient.ILibraryInfo parameter.

exportableBaselineId - Mandatory int parameter.

comparisonSettingsList - Mandatory otaclient.IList parameter.

importedEntityId - Mandatory int parameter.

exportableEntityId - Mandatory int parameter.

compareEntityType - Mandatory java.lang.String parameter.

Returns:

Returns a value of type otaclient.IList

compareVersionedEntities

IList compareVersionedEntities(int entityID,
                               int firstVersionId,
                               int secondVersionId,
                               IList comparisonSettingsList,
                               String compareEntityType)

Compares two versions of entity using a given set of comparison settings

Parameters:

entityID - Mandatory int parameter.

firstVersionId - Mandatory int parameter.

secondVersionId - Mandatory int parameter.

comparisonSettingsList - Mandatory otaclient.IList parameter.

compareEntityType - Mandatory java.lang.String parameter.

Returns:

Returns a value of type otaclient.IList

getComparisonStatistics

int getComparisonStatistics(boolean isLeft,
                            String folderEntityType,
                            int comparisonChangeType)

Returns the count of a given comparison change type (Added/Moved/Modified/Removed) for a given entity folder type (e.g. REQ / ALL_LISTS / COMPONENT_FOLDER) for a given tree (Left/Right)

Parameters:

isLeft - Mandatory boolean parameter.

folderEntityType - Mandatory java.lang.String parameter.

comparisonChangeType - Mandatory int parameter.

Returns:

Returns a value of type int