GetRequirednessForUser

Description

Identifies the behavior of the specified field.

A field can be mandatory, optional, or read-only. If the Entity does not have an action running at the time this method is called, the return value will always be READONLY. If an action is running, the return value can be READONLY, MANDATORY, or OPTIONAL.

This method never returns the value USE_HOOK. If the behavior of the field is determined by a permission hook, HCL Compass has already executed that hook and cached the resulting value. This method then returns the cached value.

Syntax

Perl

$fieldInfo->GetRequirednessForUser(); 

Identifier

Description

fieldInfo

A FieldInfo object, which contains information about one field of a user data record.

Return value

A Long that identifies the behavior of this field. The value corresponds to one of the Behavior enumeration constants (with the exception of the USE_HOOK constant).