Guides

Family Name attribute

Suggest Edits
Attribute type idType specific restriction parameters
string

📘

Family Name attribute is one of the “special” attributes used to represent properties of family. Since in PDX families are not represented as separate objects, this attribute is used to represent the family name.

This attribute is typically used in systems where retrieval is enabled, and family has a separate name from it’s members.

Code Examples:

{
  "id" : "FAMILY_NAME",
  "name" : "Family Name",
  "type" : {
    "id" : "string",
    "restriction" : {
      "parameters" : {
        "minLength" : "4",
        "maxLength" : "120"
      }
    }
  }
}

Attribute familyName = AttributeBuilder.familyNameAttribute("FAMILY_NAME", "Family Name")
        .withMinLength(4)
        .withMaxLength(120)
        .build();

Updated about 1 year ago