Package step.repository.alm.v16.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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addObjectToVcs​(java.lang.String ignored, java.lang.String comments)
      For HP use.
      void checkIn​(java.lang.String ignored, java.lang.String comments, boolean ignored1, boolean ignored2)
      Checks in an object.
      void checkInEx​(java.lang.String ignored, java.lang.String comments, boolean ignored1, boolean ignored2, boolean forceCheckin, int ignored3)
      Checks in an object.
      void checkOut​(java.lang.String version, java.lang.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​(java.lang.String bstrVersion)
      For future use.
      java.lang.String currentVersion()
      The current object latest version.
      void deleteObjectFromVCS()
      For HP use.
      boolean isCheckedOut()
      Checks if the object is in CHECKED-OUT or GET status.
      boolean isLocked()
      Obsolete.
      java.lang.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​(java.lang.String version)
      [DEPRECATED]For HP use.
      void undoCheckout​(boolean ignored)
      Undoes the check out operation, falling back to the current version on the server.
      java.lang.String version()
      The version the current user is viewing.
      com4j.Com4jObject versionInfo​(java.lang.String version)
      A reference to a VersionItem object containing information about a specific version, specified by the Version argument.
      IList versions()
      For HP use.
      java.lang.Object versions​(int index)  
      IList versionsEx()
      A list of IVersionItem references for accessing the details of each version of the object.
      java.lang.Object versionsEx​(int index)  
      void viewVersion​(java.lang.String bstrVersion, com4j.Holder<java.lang.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

        java.lang.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("1.1.1")
                    java.lang.String ignored,
                    @DefaultValue("Object Created in VCS.")
                    java.lang.String comments)

        For HP use. 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()

        For HP use. Generally unnecessary as Test deletion covers this functionality. Deletes the object from the Version Control database.

      • checkOut

        void checkOut​(java.lang.String version,
              java.lang.String comment,
              boolean ignored,
              @DefaultValue("0")
              boolean readOnly,
              @DefaultValue("-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​(java.lang.String ignored,
             java.lang.String comments,
             @DefaultValue("-1")
             boolean ignored1,
             @DefaultValue("-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​(java.lang.String version)

        [DEPRECATED]For HP use. 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

        java.lang.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 step.repository.alm.v16.otaclient.IList

      • versions

        java.lang.Object versions​(int index)

      • lockedBy

        java.lang.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​(java.lang.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​(java.lang.String bstrVersion,
                 com4j.Holder<java.lang.String> bstrViewPath)

        For HP use. Method ViewVersion.

        Parameters:
        bstrVersion - Mandatory java.lang.String parameter.
        bstrViewPath - Mandatory Holder parameter.

      • clearView

        void clearView​(@DefaultValue("")
               java.lang.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 of the object.

        Getter method for the COM property "VersionsEx"

        Returns:
        Returns a value of type step.repository.alm.v16.otaclient.IList

      • versionsEx

        java.lang.Object versionsEx​(int index)

      • refresh

        void refresh()

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

      • checkInEx

        void checkInEx​(java.lang.String ignored,
               java.lang.String comments,
               @DefaultValue("-1")
               boolean ignored1,
               @DefaultValue("-1")
               boolean ignored2,
               @DefaultValue("0")
               boolean forceCheckin,
               @DefaultValue("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