step.repository.alm.otaclient

Interface IVCS

All Superinterfaces:

com4j.Com4jObject

All Known Subinterfaces:

IVCS2

public interface IVCS
extends com4j.Com4jObject

Represents a Version Control System connection for Test objects.

Method Summary

Modifier and Type	Method and Description
void	addObjectToVcs(String ignored, String comments) Adds an object to the Version control database.
void	checkIn(String ignored, String comments, boolean ignored1, boolean ignored2) Checks in an object.
void	checkInEx(String ignored, String comments, boolean ignored1, boolean ignored2, boolean forceCheckin, int ignored3) Checks in an object.
void	checkOut(String version, String comment, boolean ignored, boolean readOnly, boolean ignored1) Checks out an object
com4j.Com4jObject	checkoutInfo() A reference to a VersionItem object, containing the checkout information of the current object.
void	clearView(String bstrVersion) For future use.
String	currentVersion() The current object latest version.
void	deleteObjectFromVCS() Deletes the object from the Version Control database.
boolean	isCheckedOut() Checks if the object is in CHECKED-OUT or GET status.
boolean	isLocked() Obsolete.
String	lockedBy() The name of the locking user.
void	lockVcsObject() For HP use.
void	refresh() Refreshes the VCS object from the server to the client, overwriting values in memory.
void	setCurrentVersion(String version) [DEPRECATED]This method is potentially destructive.
void	undoCheckout(boolean ignored) Undoes the check out operation, falling back to the current version on the server.
String	version() The version the current user is viewing.
com4j.Com4jObject	versionInfo(String version) A reference to a VersionItem object containing information about a specific version, specified by the Version argument.
IList	versions() For HP use.
Object	versions(int index)
IList	versionsEx() A list of IVersionItem references for accessing the details of each version in the object.
Object	versionsEx(int index)
void	viewVersion(String bstrVersion, com4j.Holder<String> bstrViewPath) For HP use.

Methods inherited from interface com4j.Com4jObject

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

Method Detail

version

String version()

The version the current user is viewing.

Getter method for the COM property "Version"

Returns:

Returns a value of type java.lang.String

isCheckedOut

boolean isCheckedOut()

Checks if the object is in CHECKED-OUT or GET status.

Getter method for the COM property "IsCheckedOut"

Returns:

Returns a value of type boolean

isLocked

boolean isLocked()

Obsolete. Always returns false.

Getter method for the COM property "IsLocked"

Returns:

Returns a value of type boolean

addObjectToVcs

void addObjectToVcs(@DefaultValue(value="1.1.1")
                    String ignored,
                    @DefaultValue(value="Object Created in VCS")
                    String comments)

Adds an object to the Version control database.

Parameters:

ignored - Optional parameter. Default value is "1.1.1"

comments - Optional parameter. Default value is "Object Created in VCS"

deleteObjectFromVCS

void deleteObjectFromVCS()

Deletes the object from the Version Control database.

checkOut

void checkOut(String version,
              String comment,
              boolean ignored,
              @DefaultValue(value="0")
              boolean readOnly,
              @DefaultValue(value="-1")
              boolean ignored1)

Checks out an object

Parameters:

version - Mandatory java.lang.String parameter.

comment - Mandatory java.lang.String parameter.

ignored - Mandatory boolean parameter.

readOnly - Optional parameter. Default value is false

ignored1 - Optional parameter. Default value is false

checkIn

void checkIn(String ignored,
             String comments,
             @DefaultValue(value="-1")
             boolean ignored1,
             @DefaultValue(value="-1")
             boolean ignored2)

Checks in an object.

Parameters:

ignored - Mandatory java.lang.String parameter.

comments - Mandatory java.lang.String parameter.

ignored1 - Optional parameter. Default value is false

ignored2 - Optional parameter. Default value is false

setCurrentVersion

void setCurrentVersion(String version)

[DEPRECATED]This method is potentially destructive. Use only if necessary and with care. Sets the VCS object current version.

Parameters:

version - Mandatory java.lang.String parameter.

lockVcsObject

void lockVcsObject()

For HP use. Changes VCS object status from GET to CHECK-OUT. The object must be in a GET status to use this method.

undoCheckout

void undoCheckout(boolean ignored)

Undoes the check out operation, falling back to the current version on the server.

Parameters:

ignored - Mandatory boolean parameter.

currentVersion

String currentVersion()

The current object latest version.

Getter method for the COM property "CurrentVersion"

Returns:

Returns a value of type java.lang.String

checkoutInfo

com4j.Com4jObject checkoutInfo()

A reference to a VersionItem object, containing the checkout information of the current object.

Getter method for the COM property "CheckoutInfo"

Returns:

Returns a value of type com4j.Com4jObject

versions

IList versions()

For HP use. Returns a list of references to the VersionItem objects of this entity.

Getter method for the COM property "Versions"

Returns:

Returns a value of type otaclient.IList

versions

Object versions(int index)

lockedBy

String lockedBy()

The name of the locking user.

Getter method for the COM property "LockedBy"

Returns:

Returns a value of type java.lang.String

versionInfo

com4j.Com4jObject versionInfo(String version)

A reference to a VersionItem object containing information about a specific version, specified by the Version argument.

Getter method for the COM property "VersionInfo"

Parameters:

version - Mandatory java.lang.String parameter.

Returns:

Returns a value of type com4j.Com4jObject

viewVersion

void viewVersion(String bstrVersion,
                 com4j.Holder<String> bstrViewPath)

For HP use. Method ViewVersion.

Parameters:

bstrVersion - Mandatory java.lang.String parameter.

bstrViewPath - Mandatory Holder parameter.

clearView

void clearView(@DefaultValue(value="")
               String bstrVersion)

For future use.

Parameters:

bstrVersion - Optional parameter. Default value is ""

versionsEx

IList versionsEx()

A list of IVersionItem references for accessing the details of each version in the object. .

Getter method for the COM property "VersionsEx"

Returns:

Returns a value of type otaclient.IList

versionsEx

Object versionsEx(int index)

refresh

void refresh()

Refreshes the VCS object from the server to the client, overwriting values in memory.

checkInEx

void checkInEx(String ignored,
               String comments,
               @DefaultValue(value="-1")
               boolean ignored1,
               @DefaultValue(value="-1")
               boolean ignored2,
               @DefaultValue(value="0")
               boolean forceCheckin,
               @DefaultValue(value="0")
               int ignored3)

Checks in an object.

Parameters:

ignored - Mandatory java.lang.String parameter.

comments - Mandatory java.lang.String parameter.

ignored1 - Optional parameter. Default value is false

ignored2 - Optional parameter. Default value is false

forceCheckin - Optional parameter. Default value is false

ignored3 - Optional parameter. Default value is 0