jp.go.nict.langrid.service_1_2.foundation.serviceaccessrightmanagement

Interface ServiceAccessRightManagementService

All Known Implementing Classes:

ServiceAccessRightManagement

public interface ServiceAccessRightManagementService

Service to carry out access privilege administration.

Version:

$Revision: 225 $

Author:

$Author: t-nakaguchi $

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Deletes access privilege data.
void	deleteAccessRight(String userId, String serviceId) Deletes access privilege.
AccessRight	getMyAccessRight(String serviceId) Searches access privilege data of the called user.
AccessRightSearchResult	searchAccessRights(int startIndex, int maxCount, String userId, String serviceId, Order[] orders) Searches access privilege data over the specified conditions, sorts and returns.
void	setAccessRight(String userId, String serviceId, boolean permitted) Sets access privilege.

Method Detail

clear

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

Deletes access privilege 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 unexpected exception occurred

searchAccessRights

AccessRightSearchResult searchAccessRights(int startIndex,
                                         int maxCount,
                                         String userId,
                                         String serviceId,
                                         Order[] orders)
                                           throws AccessLimitExceededException,
                                                  InvalidParameterException,
                                                  NoAccessPermissionException,
                                                  ServiceConfigurationException,
                                                  UnknownException

Searches access privilege data over the specified conditions, sorts and returns.

Parameters:

startIndex - Starting position of result acquisition

maxCount - Maximum number of acquired results

userId - Target user ID for searching access privilege

serviceId - Target service IDs of searched access privileges

orders - Sort condition

Returns:

From among the search results, the data in the range specified by startIndex and maxCount

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

getMyAccessRight

AccessRight getMyAccessRight(String serviceId)
                             throws AccessLimitExceededException,
                                    InvalidParameterException,
                                    NoAccessPermissionException,
                                    ServiceConfigurationException,
                                    UnknownException

Searches access privilege data of the called user.

Parameters:

serviceId - Service ID

Returns:

Access permission

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

setAccessRight

void setAccessRight(String userId,
                  String serviceId,
                  boolean permitted)
                    throws AccessLimitExceededException,
                           InvalidParameterException,
                           NoAccessPermissionException,
                           ServiceConfigurationException,
                           UnknownException

Sets access privilege. Overwrites when the access privilege against the same user or service is already set.

Parameters:

userId - User ID

serviceId - Service ID

permitted - Whether permitted or not

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

deleteAccessRight

void deleteAccessRight(String userId,
                     String serviceId)
                       throws AccessLimitExceededException,
                              AccessRightNotFoundException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              UnknownException

Deletes access privilege.

Parameters:

userId - Target user ID of the access privilege to be deleted. To specify all, use "*"

serviceId - Target service IDs of access privileges to be deleted. To specify all, use "*"

Throws:

AccessLimitExceededException - Violated an access restriction

AccessRightNotFoundException - The access privilege does not exist

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