Package step.repository.alm.v16.otaclient

Interface ICustomizationUsersGroup

  • All Superinterfaces:
    com4j.Com4jObject
    All Known Subinterfaces:
    ICustomizationUsersGroup2, ICustomizationUsersGroup3
    public interface ICustomizationUsersGroup
extends com4j.Com4jObject
    Represents a user group for purposes of adding and removing users.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addUser​(java.lang.Object user)
      Adds a new user to the user group.
      boolean deleted()
      If true, the object is marked for deletion, but the deletion has not been committed.
      void deleted​(boolean pVal)
      If true, the object is marked for deletion, but the deletion has not been committed.
      java.lang.String hideFilter​(java.lang.String filterType)
      The data hiding filter for the entity specified by the FilterType parameter.
      void hideFilter​(java.lang.String filterType, java.lang.String pVal)
      The data hiding filter for the entity specified by the FilterType parameter.
      int id()
      The user group ID.
      boolean is_System()
      Deprecated.
      boolean isSystem()
      Checks if the user group is a built-in system user group.
      java.lang.String name()
      The user group name.
      void name​(java.lang.String pVal)
      The user group name.
      void removeUser​(java.lang.Object user)
      Removes a user from the user group.
      boolean updated()
      Indicates if the object has been modified since being downloaded from database.
      void updated​(boolean pVal)
      Indicates if the object has been modified since being downloaded from database.
      IList usersList()
      A list of all members of the user group.
      java.lang.Object usersList​(int index)  

      • Methods inherited from interface com4j.Com4jObject

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

    • Method Detail

      • id

        int id()

        The user group ID.

        Getter method for the COM property "ID"

        Returns:
        Returns a value of type int

      • name

        java.lang.String name()

        The user group name.

        Getter method for the COM property "Name"

        Returns:
        Returns a value of type java.lang.String

      • name

        void name​(java.lang.String pVal)

        The user group name.

        Setter method for the COM property "Name"

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

      • is_System

        boolean is_System()

        Deprecated. Use IsSystem, which uses better error handling.

        Getter method for the COM property "Is_System"

        Returns:
        Returns a value of type boolean

      • addUser

        void addUser​(java.lang.Object user)

        Adds a new user to the user group.

        Parameters:
        user - Mandatory java.lang.Object parameter.

      • removeUser

        void removeUser​(java.lang.Object user)

        Removes a user from the user group.

        Parameters:
        user - Mandatory java.lang.Object parameter.

      • usersList

        IList usersList()

        A list of all members of the user group.

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

      • usersList

        java.lang.Object usersList​(int index)

      • updated

        boolean updated()

        Indicates if the object has been modified since being downloaded from database.

        Getter method for the COM property "Updated"

        Returns:
        Returns a value of type boolean

      • updated

        void updated​(boolean pVal)

        Indicates if the object has been modified since being downloaded from database.

        Setter method for the COM property "Updated"

        Parameters:
        pVal - Mandatory boolean parameter.

      • deleted

        boolean deleted()

        If true, the object is marked for deletion, but the deletion has not been committed.

        Getter method for the COM property "Deleted"

        Returns:
        Returns a value of type boolean

      • deleted

        void deleted​(boolean pVal)

        If true, the object is marked for deletion, but the deletion has not been committed.

        Setter method for the COM property "Deleted"

        Parameters:
        pVal - Mandatory boolean parameter.

      • isSystem

        boolean isSystem()

        Checks if the user group is a built-in system user group.

        Getter method for the COM property "IsSystem"

        Returns:
        Returns a value of type boolean

      • hideFilter

        java.lang.String hideFilter​(java.lang.String filterType)

        The data hiding filter for the entity specified by the FilterType parameter.

        Getter method for the COM property "HideFilter"

        Parameters:
        filterType - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type java.lang.String

      • hideFilter

        void hideFilter​(java.lang.String filterType,
                java.lang.String pVal)

        The data hiding filter for the entity specified by the FilterType parameter.

        Setter method for the COM property "HideFilter"

        Parameters:
        filterType - Mandatory java.lang.String parameter.
        pVal - Mandatory java.lang.String parameter.