GetActionDefNames

Description

Returns the action names defined in the EntityDef object.

The list of actions is returned in no particular order. You must examine each entry in the array until you find the name of the action you are looking for.

Like the other parts of an EntityDef object, the administrator sets the defined actions using HCL Compass Designer. They cannot be set directly from the API.

Syntax

VBScript

entitydef.GetActionDefNames 

Perl

$entitydef->GetActionDefNames(); 

Identifier

Description

entitydef

An EntityDef object corresponding to a record type in a schema.

Return value

For Visual Basic, a Variant containing an Array whose elements are strings. Each String names one action. If the EntityDef object has no actions, the return value is an Empty Variant.

For Perl, a reference to an array of strings.

Examples

VBScript

set sessionObj  = GetSession
set entityDefObj = sessionObj.GetEntityDef(GetEntityDefName())

sessionObj.OutputDebugString "Action names for " & entityDefObj.GetName()

nameList = entityDefObj.GetActionDefNames()
For Each actionName in nameList
   sessionObj.OutputDebugString actionName
Next 

Perl

$sessionObj = $entity->GetSession();
$sessionObj->GetEntityDef($entity->GetEntityDefName());



$sessionObj->OutputDebugString("Action names for "$entityDefObj->GetName());



$nameList = $entityDefObj->GetActionDefNames();

foreach $actionName(@$nameList)
   {
 $sessionObj->OutputDebugString($actionName);

 }