EntityDef object methods

The following list summarizes the EntityDef object methods:

Method name
Description
CanBeSecurityContext
Tests whether access to a record type can be controlled with security privileges.
CanBeSecurityContextField
Tests whether access to a field can be controlled with security privileges.
DoesTransitionExist
Returns the list of transitions that exist between two states.
GetActionDefNames
Returns the action names defined in the EntityDef object.
GetActionDefType
Identifies the type of the specified action.
GetActionDestStateName
Returns the name of the destination state of a given action def.
GetActionSourceStateNames
Returns the source state names associated with the current action.
GetFamilyMembers
Returns an EntityDefs object containing the Entity types that are members of the Family.
GetFieldDefNames
Returns the field names defined in the EntityDef object.
GetFieldDefType
Identifies the type of data that can be stored in the specified field.
GetFieldHelpText
Returns the Help Text information for a given field in a record type.
GetFieldReferenceEntityDef
Returns the type of record referenced by the specified field.
GetFieldRequiredness
Returns the behavior (requiredness) of a field as defined in the schema for a given state.
GetHookDefNames
Returns the list of named hooks associated with records of this type.
GetLocalFieldPathNames
Returns the path names of local fields.
GetName
Returns the name of the EntityDef object's corresponding record type.
GetParentFamilies
Returns an EntityDefs object containing the Entity types in all Families that the EntityDef is a member of.
GetStateDefNames
Returns the state names defined in the EntityDef object.
GetType
Returns the type (state-based or stateless) of the EntityDef.
IsActionDefName
Identifies whether the EntityDef object contains an action with the specified name.
IsFamily
Returns true of a given entitydef defines a family.
IsFieldDefName
Identifies whether the EntityDef object contains a field with the specified name.
IsSecurityContext
Tests whether this record type is used as a security context.
IsSecurityContextField
Tests whether a field is used as a security context.
IsStateDefName
Identifies whether the EntityDef object contains a state with the specified name.
IsSystemOwnedFieldDefName
Returns a Bool indicating whether the specified field is owned by the system.