step.repository.alm.otaclient

Interface IDashboardFolder

All Superinterfaces:

com4j.Com4jObject, IBaseField, IObjectLockingSupport

public interface IDashboardFolder
extends IBaseField

For HP use. Represents a Dashboard folder.

Method Summary

Modifier and Type	Method and Description
boolean	_public() Indicates whether this is a public Dashboard folder.
void	_public(boolean pVal) Indicates whether this is a public Dashboard folder.
com4j.Com4jObject	dashboardFolderFactory() The DashboardFolderFactory object for Dashboard folders that are direct children of this folder.
com4j.Com4jObject	dashboardPageFactory() The DashboardPageFactory object for managing the child pages entities
String	description() The Dashboard folder's description.
void	description(String pVal) The Dashboard folder's description.
String	name() The Dashboard folder's name
void	name(String pVal) The Dashboard folder's name
String	ownerUser() The user name of the dashboard folder's owner.
int	parentId() The ID of the folder that contains this folder.
void	parentId(int pVal) The ID of the folder that contains this folder.

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 Dashboard folder's name

Getter method for the COM property "Name"

Returns:

Returns a value of type java.lang.String

name

void name(String pVal)

The Dashboard folder's name

Setter method for the COM property "Name"

Parameters:

pVal - Mandatory java.lang.String parameter.

parentId

int parentId()

The ID of the folder that contains this folder.

Getter method for the COM property "ParentId"

Returns:

Returns a value of type int

parentId

void parentId(int pVal)

The ID of the folder that contains this folder.

Setter method for the COM property "ParentId"

Parameters:

pVal - Mandatory int parameter.

_public

boolean _public()

Indicates whether this is a public Dashboard folder.

Getter method for the COM property "Public"

Returns:

Returns a value of type boolean

_public

void _public(boolean pVal)

Indicates whether this is a public Dashboard folder.

Setter method for the COM property "Public"

Parameters:

pVal - Mandatory boolean parameter.

dashboardFolderFactory

com4j.Com4jObject dashboardFolderFactory()

The DashboardFolderFactory object for Dashboard folders that are direct children of this folder.

Getter method for the COM property "DashboardFolderFactory"

Returns:

Returns a value of type com4j.Com4jObject

dashboardPageFactory

com4j.Com4jObject dashboardPageFactory()

The DashboardPageFactory object for managing the child pages entities

Getter method for the COM property "DashboardPageFactory"

Returns:

Returns a value of type com4j.Com4jObject

description

String description()

The Dashboard folder's description.

Getter method for the COM property "Description"

Returns:

Returns a value of type java.lang.String

description

void description(String pVal)

The Dashboard folder's description.

Setter method for the COM property "Description"

Parameters:

pVal - Mandatory java.lang.String parameter.

ownerUser

String ownerUser()

The user name of the dashboard folder's owner.

Getter method for the COM property "OwnerUser"

Returns:

Returns a value of type java.lang.String