step.repository.alm.otaclient

Interface IFavorite

All Superinterfaces:

com4j.Com4jObject, IBaseField, IObjectLockingSupport

public interface IFavorite
extends IBaseField

For HP use. A user-defined display setting that is saved for reuse.

Method Summary

Modifier and Type	Method and Description
boolean	_public() Checks whether this favorite is public.
String	filterData() The favorite's filter in XML.
void	filterData(String pVal) The favorite's filter in XML.
String	layoutData() The display attributes in XML.
void	layoutData(String pVal) The display attributes in XML.
String	module() The user-interface module to which the setting applies.
String	name() The favorite's name.
void	name(String pVal) The favorite's name.
int	parentId() The ID of the favorites folder containing this item.
void	parentId(int pVal) The ID of the favorites folder containing this item.

Methods inherited from interface step.repository.alm.otaclient.IBaseField

autoPost, autoPost, field, field, id, modified, post, refresh, undo, virtual

Methods inherited from interface step.repository.alm.otaclient.IObjectLockingSupport

isLocked, lockObject, unLockObject

Methods inherited from interface com4j.Com4jObject

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

Method Detail

name

String name()

The favorite's name.

Getter method for the COM property "Name"

Returns:

Returns a value of type java.lang.String

name

void name(String pVal)

The favorite's name.

Setter method for the COM property "Name"

Parameters:

pVal - Mandatory java.lang.String parameter.

parentId

int parentId()

The ID of the favorites folder containing this item.

Getter method for the COM property "ParentId"

Returns:

Returns a value of type int

parentId

void parentId(int pVal)

The ID of the favorites folder containing this item.

Setter method for the COM property "ParentId"

Parameters:

pVal - Mandatory int parameter.

_public

boolean _public()

Checks whether this favorite is public.

Getter method for the COM property "Public"

Returns:

Returns a value of type boolean

module

String module()

The user-interface module to which the setting applies.

Getter method for the COM property "Module"

Returns:

Returns a value of type java.lang.String

filterData

String filterData()

The favorite's filter in XML.

Getter method for the COM property "FilterData"

Returns:

Returns a value of type java.lang.String

filterData

void filterData(String pVal)

The favorite's filter in XML.

Setter method for the COM property "FilterData"

Parameters:

pVal - Mandatory java.lang.String parameter.

layoutData

String layoutData()

The display attributes in XML.

Getter method for the COM property "LayoutData"

Returns:

Returns a value of type java.lang.String

layoutData

void layoutData(String pVal)

The display attributes in XML.

Setter method for the COM property "LayoutData"

Parameters:

pVal - Mandatory java.lang.String parameter.