step.repository.alm.otaclient

Interface ICustomizationUser

All Superinterfaces:

com4j.Com4jObject

public interface ICustomizationUser
extends com4j.Com4jObject

Represents a user for purposes of adding and removing the user to and from user groups.

Method Summary

Modifier and Type	Method and Description
String	address() A text field that can be used to record user information as appropriate for the project.
void	address(String pVal) A text field that can be used to record user information as appropriate for the project.
void	addToGroup(Object group) Adds this user to the specified user group.
boolean	deleted() If true, this user is marked for deletion, but the deletion is not yet committed.
void	deleted(boolean pVal) If true, this user is marked for deletion, but the deletion is not yet committed.
String	domainAuthentication() The user credentials for LDAP authentication.
void	domainAuthentication(String pVal) The user credentials for LDAP authentication.
String	email() The user's e-mail address.
void	email(String pVal) The user's e-mail address.
String	fullName() The user's full name.
void	fullName(String pVal) The user's full name.
IList	groupsList() The names of all the user groups to which this user belongs.
Object	groupsList(int index)
boolean	in_Group(Object groupName) Deprecated.
void	in_Group(Object groupName, boolean pVal) Deprecated.
boolean	inGroup(Object groupName) Indicates if this user is a member of the specified group.
void	inGroup(Object groupName, boolean pVal) Indicates if this user is a member of the specified group.
String	name() A unique name by which to identify this user.
void	password(String rhs) Sets the user's password.
String	phone() The user's telephone number.
void	phone(String pVal) The user's telephone number.
void	removeFromGroup(Object group) Removes this user from the specified user group.
boolean	updated() Indicates if the user's data was updated since the last synchronization with the server.
void	updated(boolean pVal) Indicates if the user's data was updated since the last synchronization with the server.

Methods inherited from interface com4j.Com4jObject

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

Method Detail

address

String address()

A text field that can be used to record user information as appropriate for the project.

Getter method for the COM property "Address"

Returns:

Returns a value of type java.lang.String

address

void address(String pVal)

A text field that can be used to record user information as appropriate for the project.

Setter method for the COM property "Address"

Parameters:

pVal - Mandatory java.lang.String parameter.

email

String email()

The user's e-mail address.

Getter method for the COM property "Email"

Returns:

Returns a value of type java.lang.String

email

void email(String pVal)

The user's e-mail address.

Setter method for the COM property "Email"

Parameters:

pVal - Mandatory java.lang.String parameter.

fullName

String fullName()

The user's full name.

Getter method for the COM property "FullName"

Returns:

Returns a value of type java.lang.String

fullName

void fullName(String pVal)

The user's full name.

Setter method for the COM property "FullName"

Parameters:

pVal - Mandatory java.lang.String parameter.

phone

String phone()

The user's telephone number.

Getter method for the COM property "Phone"

Returns:

Returns a value of type java.lang.String

phone

void phone(String pVal)

The user's telephone number.

Setter method for the COM property "Phone"

Parameters:

pVal - Mandatory java.lang.String parameter.

name

String name()

A unique name by which to identify this user.

Getter method for the COM property "Name"

Returns:

Returns a value of type java.lang.String

updated

boolean updated()

Indicates if the user's data was updated since the last synchronization with the server.

Getter method for the COM property "Updated"

Returns:

Returns a value of type boolean

updated

void updated(boolean pVal)

Indicates if the user's data was updated since the last synchronization with the server.

Setter method for the COM property "Updated"

Parameters:

pVal - Mandatory boolean parameter.

removeFromGroup

void removeFromGroup(Object group)

Removes this user from the specified user group.

Parameters:

group - Mandatory java.lang.Object parameter.

addToGroup

void addToGroup(Object group)

Adds this user to the specified user group.

Parameters:

group - Mandatory java.lang.Object parameter.

in_Group

boolean in_Group(Object groupName)

Deprecated. User InGroup, which uses better error handling.

Getter method for the COM property "In_Group"

Parameters:

groupName - Mandatory java.lang.Object parameter.

Returns:

Returns a value of type boolean

in_Group

void in_Group(Object groupName,
              boolean pVal)

Deprecated. User InGroup, which uses better error handling.

Setter method for the COM property "In_Group"

Parameters:

groupName - Mandatory java.lang.Object parameter.

pVal - Mandatory boolean parameter.

deleted

boolean deleted()

If true, this user is marked for deletion, but the deletion is not yet committed.

Getter method for the COM property "Deleted"

Returns:

Returns a value of type boolean

deleted

void deleted(boolean pVal)

If true, this user is marked for deletion, but the deletion is not yet committed.

Setter method for the COM property "Deleted"

Parameters:

pVal - Mandatory boolean parameter.

groupsList

IList groupsList()

The names of all the user groups to which this user belongs.

Returns:

Returns a value of type otaclient.IList

groupsList

Object groupsList(int index)

password

void password(String rhs)

Sets the user's password.

Setter method for the COM property "Password"

Parameters:

rhs - Mandatory java.lang.String parameter.

inGroup

boolean inGroup(Object groupName)

Indicates if this user is a member of the specified group.

Getter method for the COM property "InGroup"

Parameters:

groupName - Mandatory java.lang.Object parameter.

Returns:

Returns a value of type boolean

inGroup

void inGroup(Object groupName,
             boolean pVal)

Indicates if this user is a member of the specified group.

Setter method for the COM property "InGroup"

Parameters:

groupName - Mandatory java.lang.Object parameter.

pVal - Mandatory boolean parameter.

domainAuthentication

String domainAuthentication()

The user credentials for LDAP authentication.

Getter method for the COM property "DomainAuthentication"

Returns:

Returns a value of type java.lang.String

domainAuthentication

void domainAuthentication(String pVal)

The user credentials for LDAP authentication.

Setter method for the COM property "DomainAuthentication"

Parameters:

pVal - Mandatory java.lang.String parameter.