SALOMEDS.UseCaseBuilder Interface Reference

Interface of the UseCaseBuilder. More...

import "SALOMEDS.idl";

Public Member Functions
boolean	Append (in SObject theObject)
boolean	Remove (in SObject theObject)
boolean	AppendTo (in SObject theFather, in SObject theObject)
boolean	InsertBefore (in SObject theFirst, in SObject theNext)
boolean	SetCurrentObject (in SObject theObject)
boolean	SetRootCurrent ()
boolean	HasChildren (in SObject theObject)
boolean	SetName (in string theName)
string	GetName ()
boolean	IsUseCase (in SObject theObject)
SObject	GetCurrentObject ()
SObject	AddUseCase (in string theName)
UseCaseIterator	GetUseCaseIterator (in SObject theObject)

---

Detailed Description

Use case in the study represents a user-managed subtree, containing all or some of the objects which exist in the study. The UseCaseBuilder interface contains a set of methods used for management of the use case in the study.

---

Member Function Documentation

boolean SALOMEDS.UseCaseBuilder.Append (  in SObject  theObject  )

Adds to the use case an object as a child of the current object of the use case. Parameters: theObject  The added SObject. Returns: True if this SObject has been added in the use case.

boolean SALOMEDS.UseCaseBuilder.Remove (  in SObject  theObject  )

Removes an object from the use case. Parameters: theObject  The deleted SObject Returns: True if this SObject has been deleted from the use case.

boolean SALOMEDS.UseCaseBuilder.AppendTo (  in SObject  theFather, in SObject  theObject )

Adds a child object theObject to the given father theFather object in the use case.

boolean SALOMEDS.UseCaseBuilder.InsertBefore (  in SObject  theFirst, in SObject  theNext )

Inserts in the use case the object theFirst before the object theNext.

boolean SALOMEDS.UseCaseBuilder.SetCurrentObject (  in SObject  theObject  )

Sets the current object of the use case.

boolean SALOMEDS.UseCaseBuilder.SetRootCurrent (   )

Makes the root object to be the current object of the use case.

boolean SALOMEDS.UseCaseBuilder.HasChildren (  in SObject  theObject  )

Returns True if the given object theObject of the use case has child objects.

boolean SALOMEDS.UseCaseBuilder.SetName (  in string  theName  )

Sets the name of the use case.

string SALOMEDS.UseCaseBuilder.GetName (   )

Gets the name of the use case.

boolean SALOMEDS.UseCaseBuilder.IsUseCase (  in SObject  theObject  )

Returns True if the given object theObject represents a use case.

SObject SALOMEDS.UseCaseBuilder.GetCurrentObject (   )

Gets the current object of the use case.

SObject SALOMEDS.UseCaseBuilder.AddUseCase (  in string  theName  )

Creates a new use case in the use case browser.

UseCaseIterator SALOMEDS.UseCaseBuilder.GetUseCaseIterator (  in SObject  theObject  )

Returns the UseCaseIterator for the given object theObject in the use case.

---