Class ProfileTypeDefinition


public final class ProfileTypeDefinition extends EntityTypeDefinition
The profile type definition.
  • Constructor Details

    • ProfileTypeDefinition

      public ProfileTypeDefinition()
      Creates an instance of ProfileTypeDefinition class.
  • Method Details

    • strongIds

      public List<StrongId> strongIds()
      Get the strongIds property: The strong IDs.
      Returns:
      the strongIds value.
    • withStrongIds

      public ProfileTypeDefinition withStrongIds(List<StrongId> strongIds)
      Set the strongIds property: The strong IDs.
      Parameters:
      strongIds - the strongIds value to set.
      Returns:
      the ProfileTypeDefinition object itself.
    • withApiEntitySetName

      public ProfileTypeDefinition withApiEntitySetName(String apiEntitySetName)
      Set the apiEntitySetName property: The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.
      Overrides:
      withApiEntitySetName in class EntityTypeDefinition
      Parameters:
      apiEntitySetName - the apiEntitySetName value to set.
      Returns:
      the EntityTypeDefinition object itself.
    • withEntityType

      public ProfileTypeDefinition withEntityType(EntityTypes entityType)
      Set the entityType property: Type of entity.
      Overrides:
      withEntityType in class EntityTypeDefinition
      Parameters:
      entityType - the entityType value to set.
      Returns:
      the EntityTypeDefinition object itself.
    • withFields

      public ProfileTypeDefinition withFields(List<PropertyDefinition> fields)
      Set the fields property: The properties of the Profile.
      Overrides:
      withFields in class EntityTypeDefinition
      Parameters:
      fields - the fields value to set.
      Returns:
      the EntityTypeDefinition object itself.
    • withInstancesCount

      public ProfileTypeDefinition withInstancesCount(Integer instancesCount)
      Set the instancesCount property: The instance count.
      Overrides:
      withInstancesCount in class EntityTypeDefinition
      Parameters:
      instancesCount - the instancesCount value to set.
      Returns:
      the EntityTypeDefinition object itself.
    • withSchemaItemTypeLink

      public ProfileTypeDefinition withSchemaItemTypeLink(String schemaItemTypeLink)
      Set the schemaItemTypeLink property: The schema org link. This helps ACI identify and suggest semantic models.
      Overrides:
      withSchemaItemTypeLink in class EntityTypeDefinition
      Parameters:
      schemaItemTypeLink - the schemaItemTypeLink value to set.
      Returns:
      the EntityTypeDefinition object itself.
    • withTimestampFieldName

      public ProfileTypeDefinition withTimestampFieldName(String timestampFieldName)
      Set the timestampFieldName property: The timestamp property name. Represents the time when the interaction or profile update happened.
      Overrides:
      withTimestampFieldName in class EntityTypeDefinition
      Parameters:
      timestampFieldName - the timestampFieldName value to set.
      Returns:
      the EntityTypeDefinition object itself.
    • withTypeName

      public ProfileTypeDefinition withTypeName(String typeName)
      Set the typeName property: The name of the entity.
      Overrides:
      withTypeName in class EntityTypeDefinition
      Parameters:
      typeName - the typeName value to set.
      Returns:
      the EntityTypeDefinition object itself.
    • withAttributes

      public ProfileTypeDefinition withAttributes(Map<String,List<String>> attributes)
      Set the attributes property: The attributes for the Type.
      Overrides:
      withAttributes in class EntityTypeDefinition
      Parameters:
      attributes - the attributes value to set.
      Returns:
      the MetadataDefinitionBase object itself.
    • withDescription

      public ProfileTypeDefinition withDescription(Map<String,String> description)
      Set the description property: Localized descriptions for the property.
      Overrides:
      withDescription in class EntityTypeDefinition
      Parameters:
      description - the description value to set.
      Returns:
      the MetadataDefinitionBase object itself.
    • withDisplayName

      public ProfileTypeDefinition withDisplayName(Map<String,String> displayName)
      Set the displayName property: Localized display names for the property.
      Overrides:
      withDisplayName in class EntityTypeDefinition
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the MetadataDefinitionBase object itself.
    • withLocalizedAttributes

      public ProfileTypeDefinition withLocalizedAttributes(Map<String,Map<String,String>> localizedAttributes)
      Set the localizedAttributes property: Any custom localized attributes for the Type.
      Overrides:
      withLocalizedAttributes in class EntityTypeDefinition
      Parameters:
      localizedAttributes - the localizedAttributes value to set.
      Returns:
      the MetadataDefinitionBase object itself.
    • withSmallImage

      public ProfileTypeDefinition withSmallImage(String smallImage)
      Set the smallImage property: Small Image associated with the Property or EntityType.
      Overrides:
      withSmallImage in class EntityTypeDefinition
      Parameters:
      smallImage - the smallImage value to set.
      Returns:
      the MetadataDefinitionBase object itself.
    • withMediumImage

      public ProfileTypeDefinition withMediumImage(String mediumImage)
      Set the mediumImage property: Medium Image associated with the Property or EntityType.
      Overrides:
      withMediumImage in class EntityTypeDefinition
      Parameters:
      mediumImage - the mediumImage value to set.
      Returns:
      the MetadataDefinitionBase object itself.
    • withLargeImage

      public ProfileTypeDefinition withLargeImage(String largeImage)
      Set the largeImage property: Large Image associated with the Property or EntityType.
      Overrides:
      withLargeImage in class EntityTypeDefinition
      Parameters:
      largeImage - the largeImage value to set.
      Returns:
      the MetadataDefinitionBase object itself.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class EntityTypeDefinition
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.