step.repository.alm.otaclient

Interface IAnalysisItemFolderFactory

All Superinterfaces:

com4j.Com4jObject, IBaseFactory, IBaseFactoryEx

public interface IAnalysisItemFolderFactory
extends IBaseFactoryEx

Services to manage analysis item folders.

Method Summary

Modifier and Type	Method and Description
IList	getChildItemsIncludedInPages(IList pIdsList, boolean inPublicPagesOnly) Returns the list of those Analysis Items that are descendants of the specified folders and are displayed on at least one dashboard page.
com4j.Com4jObject	getTreeRoot(boolean isPublic) Returns a reference to the root of the specified tree.
int	getTreeRootID(boolean isPublic) Returns the ID of the specified Analysis Tree Root.
boolean	isTreeRootEditable(boolean isPublic) For HP use.

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

mail

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

addItem, fetchLevel, fetchLevel, fields, fields, filter, history, item, newList, removeItem

Methods inherited from interface com4j.Com4jObject

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

Method Detail

getChildItemsIncludedInPages

IList getChildItemsIncludedInPages(IList pIdsList,
                                   boolean inPublicPagesOnly)

Returns the list of those Analysis Items that are descendants of the specified folders and are displayed on at least one dashboard page.

Parameters:

pIdsList - Mandatory otaclient.IList parameter.

inPublicPagesOnly - Mandatory boolean parameter.

Returns:

Returns a value of type otaclient.IList

getTreeRoot

com4j.Com4jObject getTreeRoot(boolean isPublic)

Returns a reference to the root of the specified tree.

Parameters:

isPublic - Mandatory boolean parameter.

Returns:

Returns a value of type com4j.Com4jObject

getTreeRootID

int getTreeRootID(boolean isPublic)

Returns the ID of the specified Analysis Tree Root.

Parameters:

isPublic - Mandatory boolean parameter.

Returns:

Returns a value of type int

isTreeRootEditable

boolean isTreeRootEditable(boolean isPublic)

For HP use. Checks whether the specified Analysis Tree Root is editable.

Parameters:

isPublic - Mandatory boolean parameter.

Returns:

Returns a value of type boolean