概要  パッケージ   クラス  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド

jp.go.nict.langrid.dao
インタフェース TemporaryUserDao

既知の実装クラスの一覧:
HibernateTemporaryUserDao, JsonicTemporaryUserDao, P2PGridBasisTemporaryUserDao
public interface TemporaryUserDao

一時ユーザの管理を行うDAO。

バージョン:
$Revision: 10120 $
作成者:
Takao Nakaguchi, $Author: mori $

メソッドの概要
 void addUser(TemporaryUser user)
          一時ユーザを追加する。
 void clear()
          一時ユーザ情報を消去する。
 void clearExpiredUsers()
          有効期間を過ぎた一時ユーザ情報を消去する。
 void deleteUser(String userGridId, String userId)
          一時ユーザを削除する。
 void deleteUsersOfGrid(String userGridId)
          指定されたグリッドの一時ユーザを削除する。
 String getParentUserIdIfUserAvailable(String userGridId, String userId, String password)
          一時ユーザが存在し、有効期間内の場合、親ユーザのIDを返す。
 TemporaryUser getUser(String userGridId, String userId)
          一時ユーザを取得する。
 boolean isParent(String userGridId, String ownerUserId, String userId)
          あるユーザが一時ユーザのオーナーであるかどうかを返す。
 boolean isUserExists(String userGridId, String userId)
          一時ユーザが存在する場合trueを返す。
 List<TemporaryUser> listAllUsers(String userGridId)
          全一時ユーザを列挙する。
 TemporaryUserSearchResult searchUsers(int startIndex, int maxCount, String userGridId, MatchingCondition[] conditions, Order[] orders)
          一時ユーザを検索する。
 TemporaryUserSearchResult searchUsers(int startIndex, int maxCount, String userGridId, String parentUserId, MatchingCondition[] conditions, Order[] orders)
          指定されたユーザが作成した一時ユーザを検索する。
 void setAvailableDateTime(TemporaryUser user, Calendar beginAvailableDateTime, Calendar endAvailableDateTime)
          一時ユーザの有効期間を設定する。
 

メソッドの詳細

clear

void clear()
           throws DaoException
一時ユーザ情報を消去する。

例外:
DaoException - 処理に失敗した

clearExpiredUsers

void clearExpiredUsers()
                       throws DaoException
有効期間を過ぎた一時ユーザ情報を消去する。

例外:
DaoException - 処理に失敗した

listAllUsers

List<TemporaryUser> listAllUsers(String userGridId)
                                 throws DaoException
全一時ユーザを列挙する。

パラメータ:
userGridId - ユーザのグリッドID
戻り値:
検索結果
例外:
DaoException - 処理に失敗した

searchUsers

TemporaryUserSearchResult searchUsers(int startIndex,
                                      int maxCount,
                                      String userGridId,
                                      String parentUserId,
                                      MatchingCondition[] conditions,
                                      Order[] orders)
                                      throws DaoException
指定されたユーザが作成した一時ユーザを検索する。

パラメータ:
startIndex - 開始インデックス
maxCount - 最大件数
userGridId - ユーザのグリッドID
parentUserId - 一時ユーザを作成したユーザ
conditions - 検索条件
orders - ソート順
戻り値:
検索結果
例外:
DaoException - 処理に失敗した

searchUsers

TemporaryUserSearchResult searchUsers(int startIndex,
                                      int maxCount,
                                      String userGridId,
                                      MatchingCondition[] conditions,
                                      Order[] orders)
                                      throws DaoException
一時ユーザを検索する。

パラメータ:
startIndex - 開始インデックス
maxCount - 最大件数
userGridId - ユーザのグリッドID
conditions - 検索条件
orders - ソート順
戻り値:
検索結果
例外:
DaoException - 処理に失敗した

isUserExists

boolean isUserExists(String userGridId,
                     String userId)
                     throws DaoException
一時ユーザが存在する場合trueを返す。

パラメータ:
userGridId - ユーザのグリッドID
userId - 一時ユーザのID
戻り値:
存在する場合true
例外:
DaoException - 処理に失敗した

getParentUserIdIfUserAvailable

String getParentUserIdIfUserAvailable(String userGridId,
                                      String userId,
                                      String password)
                                      throws DaoException
一時ユーザが存在し、有効期間内の場合、親ユーザのIDを返す。

パラメータ:
userGridId - ユーザのグリッドID
userId - 一時ユーザ名
password - パスワード
戻り値:
有効な場合
例外:
DaoException - 処理に失敗した

isParent

boolean isParent(String userGridId,
                 String ownerUserId,
                 String userId)
                 throws DaoException,
                        UserNotFoundException
あるユーザが一時ユーザのオーナーであるかどうかを返す。

パラメータ:
userGridId - ユーザのグリッドID
ownerUserId - オーナーユーザのID
userId - 一時ユーザのID
戻り値:
オーナーである場合true
例外:
DaoException - 処理に失敗した
UserNotFoundException - ユーザが見つからない

addUser

void addUser(TemporaryUser user)
             throws DaoException,
                    UserAlreadyExistsException
一時ユーザを追加する。

パラメータ:
user - 追加する一時ユーザ
例外:
DaoException - 処理に失敗した
UserAlreadyExistsException - 指定されたユーザは既に存在する

setAvailableDateTime

void setAvailableDateTime(TemporaryUser user,
                          Calendar beginAvailableDateTime,
                          Calendar endAvailableDateTime)
                          throws DaoException
一時ユーザの有効期間を設定する。

パラメータ:
user - ユーザ
beginAvailableDateTime - 有効期間開始日時
endAvailableDateTime - 有効期間終了日時
例外:
DaoException - 処理に失敗した

deleteUser

void deleteUser(String userGridId,
                String userId)
                throws DaoException,
                       UserNotFoundException
一時ユーザを削除する。

パラメータ:
userGridId - ユーザのグリッドID
userId - 一時ユーザ名
例外:
DaoException - 処理に失敗した
UserNotFoundException - 指定されたユーザは存在しない

deleteUsersOfGrid

void deleteUsersOfGrid(String userGridId)
                       throws DaoException
指定されたグリッドの一時ユーザを削除する。

パラメータ:
userGridId - ユーザのグリッドID
例外:
DaoException - 処理に失敗した
UserNotFoundException - 指定されたユーザは存在しない

getUser

TemporaryUser getUser(String userGridId,
                      String userId)
                      throws DaoException,
                             UserNotFoundException
一時ユーザを取得する。

パラメータ:
userGridId - ユーザのグリッドID
userId - 一時ユーザ名
戻り値:
一時ユーザ
例外:
DaoException - 処理に失敗した
UserNotFoundException - 指定されたユーザは存在しない
概要  パッケージ   クラス  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド