GetStateDefNames

Description

Returns the state names defined in the EntityDef object.

Like the other parts of an EntityDef object, the administrator sets the defined states using DevOps Plan Designer. They cannot be set directly from the API.

Syntax

Perl

$entitydef->GetStateDefNames(); 

Identifier

Description

entitydef

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

Return value

A reference to an array of strings is returned.

Example

Perl

$sessionObj = $entity->GetSession();

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



if ($entityDefObj->GetType eq $CQPerlExt::CQ_REQ_ENTITY)

 {

 $sessionObj->OutputDebugString("States of record type:
       ".$entityDefObj->GetName());



 # List the possible states of the record

 $nameList = $entityDefObj->GetStateDefNames();



foreach $stateName (@$nameList)
   {
  $sessionObj->OutputDebugString($stateName)

  }

 }