IProfileAttributeDescriptor (formcycle: bom 8.0.4-RC.1 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

ProfileAttributeDescriptor
```
public interface IProfileAttributeDescriptor
extends Serializable
```
Common interface describing a (user) profile attribute. Profile attributes are described by a type and name. Descriptors of a profile attribute are used to evaluate the value of said attribute on a given profile. E.g. A profile attribute may be described as a JSON path to the property within the profile JSON. Custom profile attribute types and how they are evaluated may be defined via IPluginProfileFilterExtension.

Since:

8.0.0

Author:

XIMA Media GmbH

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getName()`	Returns the name of the profile attribute.
`String`	`getType()`	Returns the type of the profile attribute.

- Method Detail
  - getType
```
String getType()
```
    Returns the type of the profile attribute. The type of a profile attribute determines how the name of the attribute is evaluated with a given profile. The default attribute type "JSON_PATH PROFILE_ATTRIBUTE_TYPE_JSON_PATH JSON_PATH" for example determines that the name of the attribute should be considered as a JSON path and evaluated as such on the profile.
    
    Returns:
    
    the type of the profile attribute. E.g. "JSON_PATH PROFILE_ATTRIBUTE_TYPE_JSON_PATH JSON_PATH"
  - getName
```
String getName()
```
    Returns the name of the profile attribute. The name is used in conjunction with the type to describe the attribute of a profile and used to evaluate the value said property.
    
    Returns:
    
    the name of the profile attribute. E.g. "$.path.to.attribute" for a type "JSON_PATH PROFILE_ATTRIBUTE_TYPE_JSON_PATH JSON_PATH"