LookupStateName
Description
Returns the name of the Entity object's current state.
If the Entity object is not editable, this method simply returns the current state of the record. If the Entity object is editable and the current action involves a change of state, this method returns the new state of the record.
Note: Calling
this method from an action access-control hook returns the original
state of the record regardless of whether or not the current action
is a change-state action.
Syntax
VBScript
entity.LookupStateName
Perl
$entity->LookupStateName();
- Identifier
- Description
- entity
- An Entity object representing a user data record. Inside a hook, if you omit this part of the syntax, the Entity object corresponding to the current data record is assumed (VBScript only).
- Return value
- A String containing the name of the Entity object's current state. If this Entity object is stateless, this method returns an empty String ('').
Examples
VBScript
' Find the entity's current state name
currentState = LookupStateName
Perl
# Find the entity's current state name
$currentstate = $entity->LookupStateName();