Package step.repository.alm.v16.otaclient

Interface ICustomizationUsers

  • All Superinterfaces:
    com4j.Com4jObject
    All Known Subinterfaces:
    ICustomizationUsers2, ICustomizationUsers3
    public interface ICustomizationUsers
extends com4j.Com4jObject
    Services for managing the collection of all CustomizationUser objects.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addSiteAuthenticatedUser​(java.lang.String userName, java.lang.String fullName, java.lang.String email, java.lang.String description, java.lang.String phone, java.lang.String domainAuthentication, java.lang.Object group)
      Adds site user with credentials for LDAP authentication.
      void addSiteUser​(java.lang.String userName, java.lang.String fullName, java.lang.String email, java.lang.String description, java.lang.String phone, java.lang.Object group)
      Creates a new site user.
      com4j.Com4jObject addUser​(java.lang.String name)
      Adds an existing site user to the current project.
      java.lang.String domainUsers()
      For HP use.
      java.lang.String domainUsersWithoutProjectUsers()
      For HP use.
      void removeUser​(java.lang.String name)
      Removes a user from the collection.
      com4j.Com4jObject user​(java.lang.String name)
      The CustomizationUser object representing the specified user.
      IList users()
      The list of customization users.
      java.lang.Object users​(int index)  

      • Methods inherited from interface com4j.Com4jObject

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

    • Method Detail

      • user

        com4j.Com4jObject user​(java.lang.String name)

        The CustomizationUser object representing the specified user.

        Getter method for the COM property "User"

        Parameters:
        name - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type com4j.Com4jObject

      • addUser

        com4j.Com4jObject addUser​(java.lang.String name)

        Adds an existing site user to the current project.

        Parameters:
        name - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type com4j.Com4jObject

      • users

        IList users()

        The list of customization users.

        Getter method for the COM property "Users"

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

      • users

        java.lang.Object users​(int index)

      • removeUser

        void removeUser​(java.lang.String name)

        Removes a user from the collection.

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

      • domainUsers

        java.lang.String domainUsers()

        For HP use. An internal structure that contains all of the domain users' details.

        Getter method for the COM property "DomainUsers"

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

      • addSiteUser

        void addSiteUser​(java.lang.String userName,
                 java.lang.String fullName,
                 java.lang.String email,
                 java.lang.String description,
                 java.lang.String phone,
                 java.lang.Object group)

        Creates a new site user.

        Parameters:
        userName - Mandatory java.lang.String parameter.
        fullName - Mandatory java.lang.String parameter.
        email - Mandatory java.lang.String parameter.
        description - Mandatory java.lang.String parameter.
        phone - Mandatory java.lang.String parameter.
        group - Mandatory java.lang.Object parameter.

      • domainUsersWithoutProjectUsers

        java.lang.String domainUsersWithoutProjectUsers()

        For HP use. Gets all the users that are in the domain and are not in the project.

        Getter method for the COM property "DomainUsersWithoutProjectUsers"

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

      • addSiteAuthenticatedUser

        void addSiteAuthenticatedUser​(java.lang.String userName,
                              java.lang.String fullName,
                              java.lang.String email,
                              java.lang.String description,
                              java.lang.String phone,
                              java.lang.String domainAuthentication,
                              java.lang.Object group)

        Adds site user with credentials for LDAP authentication.

        Parameters:
        userName - Mandatory java.lang.String parameter.
        fullName - Mandatory java.lang.String parameter.
        email - Mandatory java.lang.String parameter.
        description - Mandatory java.lang.String parameter.
        phone - Mandatory java.lang.String parameter.
        domainAuthentication - Mandatory java.lang.String parameter.
        group - Mandatory java.lang.Object parameter.