step.repository.alm.otaclient

Interface IModule

All Superinterfaces:

com4j.Com4jObject

public interface IModule
extends com4j.Com4jObject

For HP use. Represents a Quality Center module, such as Requirements, Defects, TestPlan, and so on.

Method Summary

Modifier and Type	Method and Description
String	description() The module description.
void	description(String pVal) The module description.
String	guid() The module GUID.
void	guid(String pVal) The module GUID.
int	id() The module ID.
String	name() The module name.
void	name(String pVal) The module name.
void	numericVisible(int rhs) Updates visibility with numeric value for the specified user group.
int	order() The module position in the framework sidebar.
void	order(int pVal) The module position in the framework sidebar.
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.
String	visible() A bit-mask string that indicates for which groups the module is visible in the user interface.
void	visible(String pVal) A bit-mask string that indicates for which groups the module is visible in the user interface.
void	visibleForGroup(int groupId, boolean rhs) Updates visibility for the specified user group.

Methods inherited from interface com4j.Com4jObject

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

Method Detail

id

int id()

The module ID.

Getter method for the COM property "ID"

Returns:

Returns a value of type int

name

String name()

The module name.

Getter method for the COM property "Name"

Returns:

Returns a value of type java.lang.String

name

void name(String pVal)

The module name.

Setter method for the COM property "Name"

Parameters:

pVal - Mandatory java.lang.String parameter.

description

String description()

The module description.

Getter method for the COM property "Description"

Returns:

Returns a value of type java.lang.String

description

void description(String pVal)

The module description.

Setter method for the COM property "Description"

Parameters:

pVal - Mandatory java.lang.String parameter.

guid

String guid()

The module GUID.

Getter method for the COM property "GUID"

Returns:

Returns a value of type java.lang.String

guid

void guid(String pVal)

The module GUID.

Setter method for the COM property "GUID"

Parameters:

pVal - Mandatory java.lang.String parameter.

visible

String visible()

A bit-mask string that indicates for which groups the module is visible in the user interface.

Getter method for the COM property "Visible"

Returns:

Returns a value of type java.lang.String

visible

void visible(String pVal)

A bit-mask string that indicates for which groups the module is visible in the user interface.

Setter method for the COM property "Visible"

Parameters:

pVal - Mandatory java.lang.String parameter.

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.

visibleForGroup

void visibleForGroup(int groupId,
                     boolean rhs)

Updates visibility for the specified user group.

Setter method for the COM property "VisibleForGroup"

Parameters:

groupId - Mandatory int parameter.

rhs - Mandatory boolean parameter.

numericVisible

void numericVisible(int rhs)

Updates visibility with numeric value for the specified user group.

Setter method for the COM property "NumericVisible"

Parameters:

rhs - Mandatory int parameter.

order

int order()

The module position in the framework sidebar.

Getter method for the COM property "Order"

Returns:

Returns a value of type int

order

void order(int pVal)

The module position in the framework sidebar.

Setter method for the COM property "Order"

Parameters:

pVal - Mandatory int parameter.