jp.go.nict.langrid.service_1_2.foundation.usermanagement

Interface TemporaryUserManagementService

All Known Implementing Classes:

TemporaryUserManagement

public interface TemporaryUserManagementService

The temporary user administration service's interface.

Version:

$Revision: 225 $

Author:

Takao Nakaguchi, $Author: t-nakaguchi $

Method Summary

Methods

Modifier and Type	Method and Description
void	addTemporaryUser(String userId, String password, Calendar beginAvailableDateTime) Adds temporary user.
void	clear() Clears all temporary user data.
void	clearExpiredUsers() Completely clears data of temporary user exceeding validity period.
void	deleteTemporaryUser(String userId) Deletes temporary user.
Calendar	getBeginAvailableDateTime(String userId) Gets initial usage date and time of temporary user.
Calendar	getEndAvailableDateTime(String userId) Gets initial usage date and time of temporary user.
TemporaryUserEntrySearchResult	searchTemporaryUsers(int startIndex, int maxCount, MatchingCondition[] conditions, Order[] orders) Searches temporary users.
void	setAvailableDateTimes(String userId, Calendar beginAvailableDateTime, Calendar endAvailableDateTime) Sets initial usage date and time of temporary user.

Method Detail

clear

void clear()
           throws AccessLimitExceededException,
                  NoAccessPermissionException,
                  ServiceConfigurationException,
                  UnknownException

Clears all temporary user data.

Throws:

AccessLimitExceededException - Violated an access restriction

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unknwon exception occurred

clearExpiredUsers

void clearExpiredUsers()
                       throws AccessLimitExceededException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              UnknownException

Completely clears data of temporary user exceeding validity period.

Throws:

AccessLimitExceededException - Violated an access restriction

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unknwon exception occurred

searchTemporaryUsers

TemporaryUserEntrySearchResult searchTemporaryUsers(int startIndex,
                                                  int maxCount,
                                                  MatchingCondition[] conditions,
                                                  Order[] orders)
                                                    throws AccessLimitExceededException,
                                                           InvalidParameterException,
                                                           NoAccessPermissionException,
                                                           ServiceConfigurationException,
                                                           UnknownException

Searches temporary users.

Parameters:

startIndex - Start index

maxCount - Number of search results

conditions - Search conditions

orders - Sort order

Returns:

User search results

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

addTemporaryUser

void addTemporaryUser(String userId,
                    String password,
                    Calendar beginAvailableDateTime)
                      throws AccessLimitExceededException,
                             InvalidParameterException,
                             InvalidUserIdException,
                             NoAccessPermissionException,
                             ServiceConfigurationException,
                             UnknownException,
                             UserAlreadyExistsException

Adds temporary user.

Parameters:

userId - Temporary user ID

password - Password

beginAvailableDateTime - Starting date and time of validation

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

InvalidUserIdException - An invalid user ID was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

UserAlreadyExistsException - The specified user already exists

deleteTemporaryUser

void deleteTemporaryUser(String userId)
                         throws AccessLimitExceededException,
                                InvalidParameterException,
                                NoAccessPermissionException,
                                ServiceConfigurationException,
                                UnknownException,
                                UserNotFoundException

Deletes temporary user.

Parameters:

userId - User ID of the user to be deleted

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

UserNotFoundException - The specified user does not exist

getBeginAvailableDateTime

Calendar getBeginAvailableDateTime(String userId)
                                   throws AccessLimitExceededException,
                                          InvalidParameterException,
                                          NoAccessPermissionException,
                                          ServiceConfigurationException,
                                          UnknownException,
                                          UserNotFoundException

Gets initial usage date and time of temporary user.

Parameters:

userId - Temporary Username

Returns:

Start date and time of usage

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

UserNotFoundException - The specified user does not exist

getEndAvailableDateTime

Calendar getEndAvailableDateTime(String userId)
                                 throws AccessLimitExceededException,
                                        InvalidParameterException,
                                        NoAccessPermissionException,
                                        ServiceConfigurationException,
                                        UnknownException,
                                        UserNotFoundException

Gets initial usage date and time of temporary user.

Parameters:

userId - Temporary Username

Returns:

End date and time of usage

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

UserNotFoundException - The specified user does not exist

setAvailableDateTimes

void setAvailableDateTimes(String userId,
                         Calendar beginAvailableDateTime,
                         Calendar endAvailableDateTime)
                           throws AccessLimitExceededException,
                                  InvalidParameterException,
                                  NoAccessPermissionException,
                                  ServiceConfigurationException,
                                  UnknownException,
                                  UserNotFoundException

Sets initial usage date and time of temporary user.

Parameters:

userId - User ID

beginAvailableDateTime - Starting date and time of usage

endAvailableDateTime - Ending date and time of usage

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

UserNotFoundException - The specified user was not found