Package org.ametys.web.usermanagement

Class SignupInvitationClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.web.usermanagement.SignupInvitationClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Contextualizable, Serviceable

public class SignupInvitationClientSideElement
extends StaticClientSideElement
implements Contextualizable

Client side element for sending invitations

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor	Description
SignupInvitationClientSideElement()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.
Map<String,Object>	removeInvitation(String siteName, List<String> emails)	Delete invitations
Map<String,Object>	resendInvitation(String siteName, String email, String populationId, String udId)	Resend an invitation
Map<String,Object>	sendInvitation(String siteName, String popAndUserDirectory, String email, String lastname, String firstname)	Send an invitation
void	service(ServiceManager serviceManager)

Methods inherited from class org.ametys.core.ui.StaticClientSideElement

_configureClass, _configureParameters, _configureScript, configureInitialParameters

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, configure, getDependencies, getId, getPluginName, getRights, getScripts, hasRight, setPluginInfo, toString

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Constructor Details

SignupInvitationClientSideElement

public SignupInvitationClientSideElement()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticFileImportsClientSideElement

Throws:

ServiceException

getScripts

public List<ClientSideElement.Script> getScripts(boolean ignoreRights,
 Map<String,Object> contextParameters)

Description copied from interface: ClientSideElement

This method return the scripts that will be used on client side. This class will be parametrized by initial and current parameters.

Specified by:

getScripts in interface ClientSideElement

Overrides:

getScripts in class StaticFileImportsClientSideElement

Parameters:

ignoreRights - True to ignore the rights verification.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The list of scripts or an empty list.

sendInvitation

public Map<String,Object> sendInvitation(String siteName,
 String popAndUserDirectory,
 String email,
 String lastname,
 String firstname)

Send an invitation

Parameters:

siteName - the site name

popAndUserDirectory - the population and user directory

email - the email

lastname - the last name. Can be null or empty

firstname - the first name. Can be null or empty

Returns:

the result map

resendInvitation

public Map<String,Object> resendInvitation(String siteName,
 String email,
 String populationId,
 String udId)

Resend an invitation

Parameters:

siteName - the site name

email - the email

populationId - the population id

udId - the user directory id

Returns:

the result map

removeInvitation

public Map<String,Object> removeInvitation(String siteName,
 List<String> emails)

Delete invitations

Parameters:

siteName - the site name

emails - the emails to delete

Returns:

the result map