step.repository.alm.otaclient

Interface ICustomizationUsersGroup

All Superinterfaces:

com4j.Com4jObject

All Known Subinterfaces:

ICustomizationUsersGroup2

public interface ICustomizationUsersGroup
extends com4j.Com4jObject

Represents a user group for purposes of adding and removing users.

Method Summary

Modifier and Type	Method and Description
void	addUser(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.
String	hideFilter(String filterType) The data hiding filter for the entity specified by the FilterType parameter.
void	hideFilter(String filterType, 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.
String	name() The user group name.
void	name(String pVal) The user group name.
void	removeUser(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.
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

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(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(Object user)

Adds a new user to the user group.

Parameters:

user - Mandatory java.lang.Object parameter.

removeUser

void removeUser(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 otaclient.IList

usersList

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

String hideFilter(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(String filterType,
                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.