jp.go.nict.langrid.service_1_2.foundation.serviceaccesslimitmanagement

Interface ServiceAccessLimitManagementService

All Known Implementing Classes:

ServiceAccessLimitManagement

public interface ServiceAccessLimitManagementService

Service to carry out access restriction administration.

Version:

$Revision: 225 $

Author:

Takao Nakaguchi, $Author: t-nakaguchi $

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Deletes access restriction data.
void	deleteAccessLimit(String userId, String serviceId, String period, String limitType) Deletes access restriction.
AccessLimit[]	getMyAccessLimits(String serviceId) Gets the access restrictions set for the called service.
AccessLimitSearchResult	searchAccessLimits(int startIndex, int maxCount, String userId, String serviceId, Order[] orders) Searches access restriction data over the specified conditions, sorts and returns.
void	setAccessLimit(String userId, String serviceId, String period, String limitType, int limitCount) Sets access restriction.

Method Detail

clear

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

Deletes access restriction 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

searchAccessLimits

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

Searches access restriction 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 restriction

serviceId - Target service IDs of searched access restrictions

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

getMyAccessLimits

AccessLimit[] getMyAccessLimits(String serviceId)
                                throws AccessLimitExceededException,
                                       InvalidParameterException,
                                       NoAccessPermissionException,
                                       ServiceConfigurationException,
                                       UnknownException

Gets the access restrictions set for the called service.

Parameters:

serviceId - Service ID

Returns:

Array of access restrictions

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

setAccessLimit

void setAccessLimit(String userId,
                  String serviceId,
                  String period,
                  String limitType,
                  int limitCount)
                    throws AccessLimitExceededException,
                           InvalidParameterException,
                           NoAccessPermissionException,
                           ServiceConfigurationException,
                           UnknownException

Sets access restriction. The access restriction data's ID is not used. Overwrites when the access restriction against the same user, service, period, or restriction is already set.

Parameters:

userId - User ID

serviceId - Service ID

period - Units of period

limitType - Restriction type

limitCount - Restriction value

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

deleteAccessLimit

void deleteAccessLimit(String userId,
                     String serviceId,
                     String period,
                     String limitType)
                       throws AccessLimitNotFoundException,
                              AccessLimitExceededException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              UnknownException

Deletes access restriction.

Parameters:

userId - User ID

serviceId - Service ID

period - Units of period

limitType - Restriction type

limitCount - Restriction value

Throws:

AccessLimitNotFoundException - The access restriction does not exist

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