Package step.repository.alm.otaclient

Interface IBaseEntityFolder

All Superinterfaces:

com4j.Com4jObject, ISysTreeNode

public interface IBaseEntityFolder
extends ISysTreeNode

For HP use. Manages the sub-floders and child entities included in one folder.

Method Summary

Modifier and Type	Method	Description
com4j.Com4jObject	addNodeDisp(String nodeName)	Adds a new child node.
com4j.Com4jObject	attachments()	The folder's AttachmentFactory object.
String	description()	The folder description.
void	description(String pVal)	The folder description.
com4j.Com4jObject	entityFactory()	Gets the TransactionFactory for the folder.
com4j.Com4jObject	entityFactoryEx(int factoryType)	Gets the entity factory for the folder according to the input type.
com4j.Com4jObject	fatherDisp()	Gets the parent node.
int	fatherID()	Gets unique parent ID.
IList	findEntity(String pattern, boolean matchCase, String filter)	Gets a list of contained business entities according to specified pattern.
boolean	hasAttachment()	This folder has at least one attachment.
void	move(Object father)	Moves folder node under new father.
void	removeNodeEx(Object node, boolean deleteSubEntity)	Deletes a folder node.
IList	subNodes()	The list of child nodes.
Object	subNodes(int index)
int	viewOrder()	The index of this folder in its parent's list of subnodes.
void	viewOrder(int pVal)	The index of this folder in its parent's list of subnodes.

Methods inherited from interface com4j.Com4jObject

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

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

addNode, attribute, child, count, depthType, father, findChildNode, findChildren, name, name, newList, newList, nodeID, path, post, refresh, removeNode

Method Detail

description

String description()

The folder description.

Getter method for the COM property "Description"

Returns:

Returns a value of type java.lang.String

description

void description(String pVal)

The folder description.

Setter method for the COM property "Description"

Parameters:

pVal - Mandatory java.lang.String parameter.

fatherID

int fatherID()

Gets unique parent ID.

Getter method for the COM property "FatherID"

Returns:

Returns a value of type int

fatherDisp

com4j.Com4jObject fatherDisp()

Gets the parent node.

Getter method for the COM property "FatherDisp"

Returns:

Returns a value of type com4j.Com4jObject

viewOrder

int viewOrder()

The index of this folder in its parent's list of subnodes.

Getter method for the COM property "ViewOrder"

Returns:

Returns a value of type int

viewOrder

void viewOrder(int pVal)

The index of this folder in its parent's list of subnodes.

Setter method for the COM property "ViewOrder"

Parameters:

pVal - Mandatory int parameter.

subNodes

IList subNodes()

The list of child nodes.

Getter method for the COM property "SubNodes"

Returns:

Returns a value of type otaclient.IList

subNodes

Object subNodes(int index)

addNodeDisp

com4j.Com4jObject addNodeDisp(String nodeName)

Adds a new child node.

Parameters:

nodeName - Mandatory java.lang.String parameter.

Returns:

Returns a value of type com4j.Com4jObject

removeNodeEx

void removeNodeEx(Object node,
                  @DefaultValue("0")
                  boolean deleteSubEntity)

Deletes a folder node.

Parameters:

node - Mandatory java.lang.Object parameter.

deleteSubEntity - Optional parameter. Default value is false

move

void move(Object father)

Moves folder node under new father.

Parameters:

father - Mandatory java.lang.Object parameter.

entityFactory

com4j.Com4jObject entityFactory()

Gets the TransactionFactory for the folder.

Getter method for the COM property "EntityFactory"

Returns:

Returns a value of type com4j.Com4jObject

hasAttachment

boolean hasAttachment()

This folder has at least one attachment.

Getter method for the COM property "HasAttachment"

Returns:

Returns a value of type boolean

attachments

com4j.Com4jObject attachments()

The folder's AttachmentFactory object.

Getter method for the COM property "Attachments"

Returns:

Returns a value of type com4j.Com4jObject

findEntity

IList findEntity(String pattern,
                 @DefaultValue("0")
                 boolean matchCase,
                 @DefaultValue("")
                 String filter)

Gets a list of contained business entities according to specified pattern.

Parameters:

pattern - Mandatory java.lang.String parameter.

matchCase - Optional parameter. Default value is false

filter - Optional parameter. Default value is ""

Returns:

Returns a value of type otaclient.IList

entityFactoryEx

com4j.Com4jObject entityFactoryEx(int factoryType)

Gets the entity factory for the folder according to the input type.

Getter method for the COM property "EntityFactoryEx"

Parameters:

factoryType - Mandatory int parameter.

Returns:

Returns a value of type com4j.Com4jObject