Package step.repository.alm.v16.otaclient

Interface _ISubjectNode3

  • All Superinterfaces:
    com4j.Com4jObject
    public interface _ISubjectNode3
extends com4j.Com4jObject
    For HP use. Adds some missing functionality to a subject folder.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ISysTreeNode addNode​(java.lang.String name, java.lang.String description, int viewOrder)
      Adds a new child node with the given data.
      boolean autoUnlock()
      Indicates whether to make the item changeable to other users automatically after a Refresh or Post.
      void autoUnlock​(boolean pVal)
      Indicates whether to make the item changeable to other users automatically after a Refresh or Post.
      IList findChildrenExact​(java.lang.String pattern, boolean matchCase, java.lang.String filter)
      Finds node children matching the name exactly according to specified search pattern.
      boolean isFieldModified​(java.lang.String fieldName, java.lang.Object oldFieldValue)
      Indicates whether the given field is modified, optionally returning the original field value.
      boolean modified()
      Checks if the item has been modified since last refresh or post operation.
      void post​(boolean undoOnFailure)
      Writes all changed values to database.
      void undo()
      Undoes changes to field values that have not been posted.
      void undoField​(java.lang.String fieldName)
      Undoes the changes made to the given field.
      boolean verifyPutFieldWithErrorOnFail​(java.lang.String fieldName, java.lang.Object newVal)
      Verifies if the given value can be put in the given field.

      • Methods inherited from interface com4j.Com4jObject

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

    • Method Detail

      • undo

        void undo()

        Undoes changes to field values that have not been posted.

      • modified

        boolean modified()

        Checks if the item has been modified since last refresh or post operation. If true, the field properties on the server side are not up to date.

        Getter method for the COM property "Modified"

        Returns:
        Returns a value of type boolean

      • autoUnlock

        boolean autoUnlock()

        Indicates whether to make the item changeable to other users automatically after a Refresh or Post.

        Getter method for the COM property "AutoUnlock"

        Returns:
        Returns a value of type boolean

      • autoUnlock

        void autoUnlock​(boolean pVal)

        Indicates whether to make the item changeable to other users automatically after a Refresh or Post.

        Setter method for the COM property "AutoUnlock"

        Parameters:
        pVal - Mandatory boolean parameter.

      • post

        void post​(@DefaultValue("-1")
          boolean undoOnFailure)

        Writes all changed values to database.

        Parameters:
        undoOnFailure - Optional parameter. Default value is false

      • isFieldModified

        boolean isFieldModified​(java.lang.String fieldName,
                        java.lang.Object oldFieldValue)

        Indicates whether the given field is modified, optionally returning the original field value.

        Parameters:
        fieldName - Mandatory java.lang.String parameter.
        oldFieldValue - Optional parameter. Default value is com4j.Variant.getMissing()
        Returns:
        Returns a value of type boolean

      • undoField

        void undoField​(java.lang.String fieldName)

        Undoes the changes made to the given field.

        Parameters:
        fieldName - Mandatory java.lang.String parameter.

      • verifyPutFieldWithErrorOnFail

        boolean verifyPutFieldWithErrorOnFail​(java.lang.String fieldName,
                                      java.lang.Object newVal)

        Verifies if the given value can be put in the given field. The checks are local, i.e. no round trips are made.

        Parameters:
        fieldName - Mandatory java.lang.String parameter.
        newVal - Mandatory java.lang.Object parameter.
        Returns:
        Returns a value of type boolean

      • addNode

        ISysTreeNode addNode​(java.lang.String name,
                     java.lang.String description,
                     int viewOrder)

        Adds a new child node with the given data.

        Parameters:
        name - Mandatory java.lang.String parameter.
        description - Mandatory java.lang.String parameter.
        viewOrder - Mandatory int parameter.
        Returns:
        Returns a value of type step.repository.alm.v16.otaclient.ISysTreeNode

      • findChildrenExact

        IList findChildrenExact​(java.lang.String pattern,
                        @DefaultValue("0")
                        boolean matchCase,
                        @DefaultValue("")
                        java.lang.String filter)

        Finds node children matching the name exactly according to specified search pattern.

        Parameters:
        pattern - Mandatory java.lang.String parameter.
        matchCase - Optional parameter. Default value is false
        filter - Optional parameter. Default value is ""
        Returns:
        Returns a value of type step.repository.alm.v16.otaclient.IList