IPluginProfileFilterValue (formcycle: bom 8.0.5-alpha.1 API)

All Known Implementing Classes:

DefaultPluginProfileFilterValue
```
public interface IPluginProfileFilterValue
```
Common interface representing a possible value for profile attribute filters used in user filters (IndirectClientAuthorization). Implementations need to implement Object.equals(Object).

Since:

8.0.0

Author:

XIMA Media GmbH

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`String`	`getDescription(Locale locale)`	Returns an optional description of the possible value option.
`String`	`getDisplayName(Locale locale)`
`default IGuiIcon`	`getIcon()`
`String`	`getValue()`

- Method Detail
  - getValue
```
String getValue()
```
    Returns:
    
    the actual profile attribute value of this filter value option. Generally this should be an immutable value such as some form of ID and not e.g. editable display names.
  - getDisplayName
```
String getDisplayName(Locale locale)
```
    Parameters:
    
    locale - Locale to be used for internationalization.
    
    Returns:
    
    the locale specific display name of the value.
  - getDescription
```
@Nullable
String getDescription(Locale locale)
```
    Returns an optional description of the possible value option. This should be a helpful notice for the user for deciding on a filter value.
    
    Parameters:
    
    locale - Locale to be used for internationalization.
    
    Returns:
    
    the locale specific description.
  - getIcon
```
@Nullable
default IGuiIcon getIcon()
```
    Returns:
    
    an optional icon to be shown for the attribute value in the configuration GUI.