com.communote.server.core.user.client

Interface ClientManagement

All Known Implementing Classes:

ClientManagementBase, ClientManagementImpl

public interface ClientManagement

Management class for client handling.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
void	createGlobalClient(String clientName, String timeZoneId) Create the global client (as entity with db config only)
ClientTO	findClient(String clientId) Get the client by its client id
Collection<ClientTO>	getAllClients()
void	initializeGlobalClient(UserVO userVO) Initializes the global client.
ClientTO	updateClientName(String clientId, String clientName) Update the name of the given client

Method Detail

createGlobalClient

void createGlobalClient(String clientName,
                        String timeZoneId)
                 throws InvalidClientIdException

Create the global client (as entity with db config only)

Throws:

InvalidClientIdException

findClient

ClientTO findClient(String clientId)
             throws ClientNotFoundException

Get the client by its client id

Throws:

ClientNotFoundException

getAllClients

Collection<ClientTO> getAllClients()

initializeGlobalClient

void initializeGlobalClient(UserVO userVO)
                     throws EmailValidationException

Initializes the global client.

Parameters:

userVO - VO with details of the user to create as administrator for the client

Throws:

EmailValidationException

updateClientName

ClientTO updateClientName(String clientId,
                          String clientName)
                   throws ClientNotFoundException

Update the name of the given client

Parameters:

clientId - the ID of the client to update

clientName - the new name

Returns:

the update client

Throws:

ClientNotFoundException - in case there is no client with the ID