EntityExists

Description

Returns an indication of whether the entity exists or not.

For stateful records, the display name argument (display_name) is the id string (for example, RAMBU00001234).

For stateless records, display_name is composed of concatenation of all the unique key field values with a space character between. For example, if a project record type has two fields, name and department, and they are both designated as unique key fields, the display_name would be "<name> <department>"

For a project with name "ACME" and department "Finance":

exists_flag = session.EntityExists "Project", "ACME Finance"  

For a project with the name "ACME" that has one unique key field, name:

exists_flag = session.EntityExists "Project", "ACME"

Syntax

VBScript

session.EntityExists entity_def_name, display_name 

Perl

$session->EntityExists(entity_def_name, display_name); 

Identifier

Description

session

The Session object that represents the current database-access session.

entity_def_name

A String containing the record type (EntityDef) name.

display_name

A String containing the display name (id string) of the record

Return value

Returns a Boolean True if the Entity exists, False otherwise.

Examples

VBScript

set sessionObj = GetSession

ResultFromEntityExist = sessionObj.EntityExists("defect", "test00000001") 

Perl

$sessionObj = $entityObj->GetSession();

$ResultFromEntityExist = $sessionObj->EntityExists("defect", "test00000001");