Package de.xima.fc.mdl.auth.filter

Class DefaultPluginProfileFilterAttribute

java.lang.Object

de.xima.fc.mdl.auth.filter.DefaultPluginProfileFilterAttribute

All Implemented Interfaces:

IPluginProfileFilterAttribute

public class DefaultPluginProfileFilterAttribute
extends Object
implements IPluginProfileFilterAttribute

Default implementation of a plugin profile attribute filter attribute.

Since:

8.0.0

Author:

XIMA Media GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultPluginProfileFilterAttribute.Builder

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
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)
IGuiIcon	getIcon()
static DefaultPluginProfileFilterAttribute.Builder	newBuilder(String attributeName)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAttributeName

public String getAttributeName()

Description copied from interface: IPluginProfileFilterAttribute

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 "#".

Specified by:

getAttributeName in interface IPluginProfileFilterAttribute

Returns:

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

getDisplayName

public String getDisplayName(Locale locale)

Specified by:

getDisplayName in interface IPluginProfileFilterAttribute

Parameters:

locale - Locale to be used for internationalization.

Returns:

the locale specific display name of the profile attribute.

getDescription

public String getDescription(Locale locale)

Description copied from interface: IPluginProfileFilterAttribute

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

Specified by:

getDescription in interface IPluginProfileFilterAttribute

Parameters:

locale - Locale to be used for internationalization.

Returns:

the locale specific description.

getIcon

public IGuiIcon getIcon()

Specified by:

getIcon in interface IPluginProfileFilterAttribute

Returns:

an optional icon to be shown for the attribute in the configuration GUI.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

newBuilder

public static DefaultPluginProfileFilterAttribute.Builder newBuilder(String attributeName)