it.eng.rdlab.soa3.um.rest
Interface IUserManagementService.OrganizationManager

All Known Implementing Classes:

OrganizationManagerImpl

Enclosing interface:

IUserManagementService

public static interface IUserManagementService.OrganizationManager

The organization interface in the user management hierarchy.

Version:

1.0

Author:

Ermanno Travaglino

Method Summary

String	createOrganization(String organizationName, String adminUserId, String adminPassword) Creates an organization by organizationName
boolean	deleteOrganization(String organizationName, String adminUserId, String adminPassword) Deletes an organization by organizationName
int	deleteOrganizations(String adminUserId, String adminPassword) Deletes all present organizations
boolean	existsOrganization(String organizationName, String adminUserId, String adminPassword) Tests if the organization organizationName exists
OrganizationModel	getOrganizationByName(String organizationName, String adminUserId, String adminPassword) Gets the organization by organizationName
List<OrganizationModel>	listOrganizations(String adminUserId, String adminPassword) Lists all present organizations
boolean	updateOrganization(OrganizationModel organization, String adminUserId, String adminPassword) Updates organization's attribute

Method Detail

createOrganization

String createOrganization(String organizationName,
                          String adminUserId,
                          String adminPassword)

Creates an organization by organizationName

Parameters:

organizationName -

adminUserId -

adminPassword -

Returns:

organization creation process response String

deleteOrganization

boolean deleteOrganization(String organizationName,
                           String adminUserId,
                           String adminPassword)

Deletes an organization by organizationName

Parameters:

organizationName -

adminUserId -

adminPassword -

Returns:

true if the organization was removed as a result of this call

deleteOrganizations

int deleteOrganizations(String adminUserId,
                        String adminPassword)

Deletes all present organizations

Parameters:

adminUserId -

adminPassword -

Returns:

0 if the organizations have been removed as a result of this call, 1 if some organization have not been removed, 2 if no organization has been removed

existsOrganization

boolean existsOrganization(String organizationName,
                           String adminUserId,
                           String adminPassword)

Tests if the organization organizationName exists

Parameters:

organizationName -

adminUserId -

adminPassword -

Returns:

true if the organization exists

updateOrganization

boolean updateOrganization(OrganizationModel organization,
                           String adminUserId,
                           String adminPassword)

Updates organization's attribute

Parameters:

organizationName -

adminUserId -

adminPassword -

Returns:

true if this organization updated as a result of the call

listOrganizations

List<OrganizationModel> listOrganizations(String adminUserId,
                                          String adminPassword)

Lists all present organizations

Parameters:

adminUserId -

adminPassword -

Returns:

a List containing all organizations

getOrganizationByName

OrganizationModel getOrganizationByName(String organizationName,
                                        String adminUserId,
                                        String adminPassword)

Gets the organization by organizationName

Parameters:

organizationName -

adminUserId -

adminPassword -

Returns:

object with specified name OrganizationModel