CanBeSecurityContextField
Description
Tests whether a field can be used as a security context field.
Syntax
VBScript
entitydef.CanBeSecurityContextField("field_name")
Perl
$entitydef->CanBeSecurityContextField(field_name);
- Identifier
- Description
- entitydef
- An EntityDef object corresponding to a record type in a schema.
- field_name
- A String containing the name of the field to be tested.
- Return value
- The return value is Boolean True if the field can be used as a security context field; otherwise the return value is Boolean False.
Security can be managed at the database, record type, and field levels. This method tests security properties at the field level.
Security cannot be managed by HCL Compass APIs. To manage security, you need to use the HCL Compass Designer and HCL Compass client.
Examples
VBScript
can_be_security_field = entitydef.CanBeSecurityContextField("field_name")
Perl
$can_be_security_field = $entitydef->CanBeSecurityContextField($field_name);