org.ametys.core.group.directory

Class DefaultGroupDirectoryModel

java.lang.Object

org.ametys.core.group.directory.DefaultGroupDirectoryModel

All Implemented Interfaces:

GroupDirectoryModel

public class DefaultGroupDirectoryModel
extends Object
implements GroupDirectoryModel

Default implementation of GroupDirectoryModel

Field Summary

Fields

Modifier and Type	Field and Description
private I18nizableText	_description
private Class<GroupDirectory>	_groupDirectoryClass
private Configuration	_groupDirectoryConfig
private String	_id
private I18nizableText	_label
private Map<String,? extends Parameter<ParameterHelper.ParameterType>>	_parameters
private String	_pluginName

Constructor Summary

Constructors

Constructor and Description
DefaultGroupDirectoryModel(String id, Class<GroupDirectory> groupDirectoryClass, Configuration groupDirectoryConfig, I18nizableText label, I18nizableText description, Map<String,? extends Parameter<ParameterHelper.ParameterType>> parameters, String pluginName) Constructor

Method Summary

Modifier and Type	Method and Description
I18nizableText	getDescription() Get the description text of the directory.
Class<GroupDirectory>	getGroupDirectoryClass() Get the group directory class
Configuration	getGroupDirectoryConfiguration() Get the additional configuration for the implementation of GroupDirectory
String	getId() Get the id of this user directory
I18nizableText	getLabel() Get the label of the directory.
Map<String,? extends Parameter<ParameterHelper.ParameterType>>	getParameters() Get the configuration parameters
String	getPluginName() Returns the plugin name of declaration (for debug purpose)

Methods inherited from class java.lang.Object

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

Field Detail

_id

private String _id

_groupDirectoryClass

private Class<GroupDirectory> _groupDirectoryClass

_groupDirectoryConfig

private Configuration _groupDirectoryConfig

_label

private I18nizableText _label

_description

private I18nizableText _description

_parameters

private Map<String,? extends Parameter<ParameterHelper.ParameterType>> _parameters

_pluginName

private String _pluginName

Constructor Detail

DefaultGroupDirectoryModel

public DefaultGroupDirectoryModel(String id,
                                  Class<GroupDirectory> groupDirectoryClass,
                                  Configuration groupDirectoryConfig,
                                  I18nizableText label,
                                  I18nizableText description,
                                  Map<String,? extends Parameter<ParameterHelper.ParameterType>> parameters,
                                  String pluginName)

Constructor

Parameters:

id - The unique identifier of this group directory model

groupDirectoryClass - The GroupDirectory class

groupDirectoryConfig - Additional configuration for GroupDirectory class. Can be empty.

label - The i18n label

description - The i18n description

parameters - the parameters

pluginName - the plugin's name of declaration (for debug purpose)

Method Detail

getId

public String getId()

Description copied from interface: GroupDirectoryModel

Get the id of this user directory

Specified by:

getId in interface GroupDirectoryModel

Returns:

the id of this user directory

getLabel

public I18nizableText getLabel()

Description copied from interface: GroupDirectoryModel

Get the label of the directory.

Specified by:

getLabel in interface GroupDirectoryModel

Returns:

the label of the directory

getDescription

public I18nizableText getDescription()

Description copied from interface: GroupDirectoryModel

Get the description text of the directory.

Specified by:

getDescription in interface GroupDirectoryModel

Returns:

the description of the directory

getParameters

public Map<String,? extends Parameter<ParameterHelper.ParameterType>> getParameters()

Description copied from interface: GroupDirectoryModel

Get the configuration parameters

Specified by:

getParameters in interface GroupDirectoryModel

Returns:

The configuration parameters

getPluginName

public String getPluginName()

Description copied from interface: GroupDirectoryModel

Returns the plugin name of declaration (for debug purpose)

Specified by:

getPluginName in interface GroupDirectoryModel

Returns:

the plugin name

getGroupDirectoryClass

public Class<GroupDirectory> getGroupDirectoryClass()

Description copied from interface: GroupDirectoryModel

Get the group directory class

Specified by:

getGroupDirectoryClass in interface GroupDirectoryModel

Returns:

the group directory class

getGroupDirectoryConfiguration

public Configuration getGroupDirectoryConfiguration()

Description copied from interface: GroupDirectoryModel

Get the additional configuration for the implementation of GroupDirectory

Specified by:

getGroupDirectoryConfiguration in interface GroupDirectoryModel

Returns:

the additional configuration.