Package de.xima.fc.interfaces.plugin.retval.auth.filter

Interface IPluginProfileFilterAttribute

All Known Implementing Classes:

DefaultPluginProfileFilterAttribute

public interface IPluginProfileFilterAttribute

Common interface representing an attribute 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

Modifier and Type	Method	Description
@NotBlank String	getAttributeName()	Returns the name of the attribute of a profile which together with the attribute type describes an attribute the profile which will be evaluated on a given profile during filter client authorization.
String	getDescription(Locale locale)	Returns an optional description of the profile attribute.
String	getDisplayName(Locale locale)
default IGuiIcon	getIcon()

Method Detail

getAttributeName

@NotBlank
@NotBlank String getAttributeName()

Returns the name of the attribute of a profile which together with the attribute type describes an attribute the profile which will be evaluated on a given profile during filter client authorization. The attribute name must not contain the symbol "#".

Returns:

the name of the attribute of the profile. Defines an attribute of the profile together with the attribute type.

getDisplayName

@Nullable
String getDisplayName(Locale locale)

Parameters:

locale - Locale to be used for internationalization.

Returns:

the locale specific display name of the profile attribute.

getDescription

@Nullable
String getDescription(Locale locale)

Returns an optional description of the profile attribute. This should be a helpful notice for the user on how to use the profile attribute.

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 in the configuration GUI.