Package org.ametys.core.user.directory

Interface UserDirectoryModel

All Known Implementing Classes:

DefaultUserDirectoryModel

public interface UserDirectoryModel

This class represents a model for a UserDirectory

Method Summary

Modifier and Type	Method	Description
I18nizableText	getDescription()	Get the description text of the directory.
String	getId()	Get the id of this user directory
I18nizableText	getLabel()	Get the label of the directory.
Map<String,? extends ItemCheckerDescriptor>	getParameterCheckers()	Get the configuration parameter checkers
Map<String,? extends ElementDefinition>	getParameters()	Get the configuration parameters
String	getPluginName()	Returns the plugin name of declaration (for debug purpose)
Class<UserDirectory>	getUserDirectoryClass()	Get the user directory class
Configuration	getUserDirectoryConfiguration()	Get the additional configuration for the implementation of UserDirectory

Method Details

getId

String getId()

Get the id of this user directory

Returns:

the id of this user directory

getLabel

I18nizableText getLabel()

Get the label of the directory.

Returns:

the label of the directory

getDescription

I18nizableText getDescription()

Get the description text of the directory.

Returns:

the description of the directory

getParameters

Map<String,? extends ElementDefinition> getParameters()

Get the configuration parameters

Returns:

The configuration parameters

getParameterCheckers

Map<String,? extends ItemCheckerDescriptor> getParameterCheckers()

Get the configuration parameter checkers

Returns:

The configuration parameter checkers

getPluginName

String getPluginName()

Returns the plugin name of declaration (for debug purpose)

Returns:

the plugin name

getUserDirectoryClass

Class<UserDirectory> getUserDirectoryClass()

Get the user directory class

Returns:

the user directory class

getUserDirectoryConfiguration

Configuration getUserDirectoryConfiguration()

Get the additional configuration for the implementation of UserDirectory

Returns:

the additional configuration.