org.wattdepot.client

Interface WattDepotAdminInterface

All Known Implementing Classes:

WattDepotAdminClient

public interface WattDepotAdminInterface

WattDepotAdminInterface - Provides the functionality for the admin. Supports manipulation of UserInfos and Organizations.

Author:

Cam Moore

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteOrganization(String id) Deletes the given Organization.
void	deleteUser(String id, String orgId) Deletes the given User.
Organization	getOrganization(String id)
OrganizationList	getOrganizations()
UserInfo	getUser(String id, String orgId)
UserPassword	getUserPassword(String id, String orgId)
UserInfoList	getUsers(String orgId)
boolean	isDefinedOrganization(String id) Checks to see if the given id is a defined Organization's id.
boolean	isDefinedUserInfo(String id, String orgId) Checks to see if the given id and orgId is a defined UserInfo id.
void	putOrganization(Organization org) Stores the given Organization in the WattDepot Server.
void	putUser(UserInfo user) Stores the given user in the WattDepot Server.
void	updateOrganization(Organization org) Updates the Organization in the WattDepot Server.
void	updateUser(UserInfo user) Updates the UserInfo in the WattDepot Server.
void	updateUserPassword(UserPassword password) Updates the Userpassword in the WattDepot Server.

Method Detail

deleteUser

void deleteUser(String id,
              String orgId)
                throws IdNotFoundException

Deletes the given User.

Parameters:

id - the unique id of the User.

orgId - the id of the user's organization.

Throws:

IdNotFoundException - if the User's id is not found.

deleteOrganization

void deleteOrganization(String id)
                        throws IdNotFoundException

Deletes the given Organization.

Parameters:

id - the unique id of the Organization.

Throws:

IdNotFoundException - if the Organization's id is not found.

getOrganization

Organization getOrganization(String id)
                             throws IdNotFoundException

Parameters:

id - The unique id of the Organization.

Returns:

The Organization with the given id.

Throws:

IdNotFoundException - if the id does not exist.

getOrganizations

OrganizationList getOrganizations()

Returns:

All the defined Organizations in an OrganizationList.

getUser

UserInfo getUser(String id,
               String orgId)
                 throws IdNotFoundException

Parameters:

id - The unique id of the UserInfo.

orgId - the id of the user's organization.

Returns:

The UserInfo with the given id.

Throws:

IdNotFoundException - if the id does not exist.

getUsers

UserInfoList getUsers(String orgId)

Parameters:

orgId - the id of the users' organization.

Returns:

All the defined Users in a UserInfoList.

getUserPassword

UserPassword getUserPassword(String id,
                           String orgId)
                             throws IdNotFoundException

Parameters:

id - The unique id of the UserPassword.

orgId - the organization id.

Returns:

The UserPassword with the given id.

Throws:

IdNotFoundException - if the id does not exist.

putUser

void putUser(UserInfo user)

Stores the given user in the WattDepot Server.

Parameters:

user - The UserInfo to store.

isDefinedOrganization

boolean isDefinedOrganization(String id)

Checks to see if the given id is a defined Organization's id.

Parameters:

id - the id to check.

Returns:

true if there is a defined Organization with the given id, false otherwise.

isDefinedUserInfo

boolean isDefinedUserInfo(String id,
                        String orgId)

Checks to see if the given id and orgId is a defined UserInfo id.

Parameters:

id - the id to check.

orgId - the organization id.

Returns:

true if there is a defined UserInfo with the given id and orgId, false otherwise.

putOrganization

void putOrganization(Organization org)

Stores the given Organization in the WattDepot Server.

Parameters:

org - the Organization to store.

updateOrganization

void updateOrganization(Organization org)

Updates the Organization in the WattDepot Server.

Parameters:

org - the Organization to update.

updateUser

void updateUser(UserInfo user)

Updates the UserInfo in the WattDepot Server.

Parameters:

user - the UserInfo to update.

updateUserPassword

void updateUserPassword(UserPassword password)
                        throws IdNotFoundException

Updates the Userpassword in the WattDepot Server.

Parameters:

password - the UserPassword to update.

Throws:

IdNotFoundException - if the user id or organization ids are not defined.