jp.go.nict.langrid.dao.jsonic
クラス JsonicTemporaryUserDao

java.lang.Object
  上位を拡張 jp.go.nict.langrid.dao.jsonic.JsonicTemporaryUserDao
すべての実装されたインタフェース:
TemporaryUserDao

public class JsonicTemporaryUserDao
extends Object
implements TemporaryUserDao

作成者:
Takao Nakaguchi

コンストラクタの概要
JsonicTemporaryUserDao(JsonicDaoContext context)
           
 
メソッドの概要
 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)
          一時ユーザの有効期間を設定する。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

JsonicTemporaryUserDao

public JsonicTemporaryUserDao(JsonicDaoContext context)
メソッドの詳細

clear

public void clear()
           throws DaoException
インタフェース TemporaryUserDao の記述:
一時ユーザ情報を消去する。

定義:
インタフェース TemporaryUserDao 内の clear
例外:
DaoException - 処理に失敗した

clearExpiredUsers

public void clearExpiredUsers()
                       throws DaoException
インタフェース TemporaryUserDao の記述:
有効期間を過ぎた一時ユーザ情報を消去する。

定義:
インタフェース TemporaryUserDao 内の clearExpiredUsers
例外:
DaoException - 処理に失敗した

listAllUsers

public List<TemporaryUser> listAllUsers(String userGridId)
                                 throws DaoException
インタフェース TemporaryUserDao の記述:
全一時ユーザを列挙する。

定義:
インタフェース TemporaryUserDao 内の listAllUsers
パラメータ:
userGridId - ユーザのグリッドID
戻り値:
検索結果
例外:
DaoException - 処理に失敗した

searchUsers

public TemporaryUserSearchResult searchUsers(int startIndex,
                                             int maxCount,
                                             String userGridId,
                                             String parentUserId,
                                             MatchingCondition[] conditions,
                                             Order[] orders)
                                      throws DaoException
インタフェース TemporaryUserDao の記述:
指定されたユーザが作成した一時ユーザを検索する。

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

searchUsers

public TemporaryUserSearchResult searchUsers(int startIndex,
                                             int maxCount,
                                             String userGridId,
                                             MatchingCondition[] conditions,
                                             Order[] orders)
                                      throws DaoException
インタフェース TemporaryUserDao の記述:
一時ユーザを検索する。

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

isUserExists

public boolean isUserExists(String userGridId,
                            String userId)
                     throws DaoException
インタフェース TemporaryUserDao の記述:
一時ユーザが存在する場合trueを返す。

定義:
インタフェース TemporaryUserDao 内の isUserExists
パラメータ:
userGridId - ユーザのグリッドID
userId - 一時ユーザのID
戻り値:
存在する場合true
例外:
DaoException - 処理に失敗した

getParentUserIdIfUserAvailable

public String getParentUserIdIfUserAvailable(String userGridId,
                                             String userId,
                                             String password)
                                      throws DaoException
インタフェース TemporaryUserDao の記述:
一時ユーザが存在し、有効期間内の場合、親ユーザのIDを返す。

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

isParent

public boolean isParent(String userGridId,
                        String ownerUserId,
                        String userId)
                 throws DaoException,
                        UserNotFoundException
インタフェース TemporaryUserDao の記述:
あるユーザが一時ユーザのオーナーであるかどうかを返す。

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

addUser

public void addUser(TemporaryUser user)
             throws DaoException,
                    UserAlreadyExistsException
インタフェース TemporaryUserDao の記述:
一時ユーザを追加する。

定義:
インタフェース TemporaryUserDao 内の addUser
パラメータ:
user - 追加する一時ユーザ
例外:
DaoException - 処理に失敗した
UserAlreadyExistsException - 指定されたユーザは既に存在する

setAvailableDateTime

public void setAvailableDateTime(TemporaryUser user,
                                 Calendar beginAvailableDateTime,
                                 Calendar endAvailableDateTime)
                          throws DaoException
インタフェース TemporaryUserDao の記述:
一時ユーザの有効期間を設定する。

定義:
インタフェース TemporaryUserDao 内の setAvailableDateTime
パラメータ:
user - ユーザ
beginAvailableDateTime - 有効期間開始日時
endAvailableDateTime - 有効期間終了日時
例外:
DaoException - 処理に失敗した

deleteUser

public void deleteUser(String userGridId,
                       String userId)
                throws DaoException,
                       UserNotFoundException
インタフェース TemporaryUserDao の記述:
一時ユーザを削除する。

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

deleteUsersOfGrid

public void deleteUsersOfGrid(String userGridId)
                       throws DaoException
インタフェース TemporaryUserDao の記述:
指定されたグリッドの一時ユーザを削除する。

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

getUser

public TemporaryUser getUser(String userGridId,
                             String userId)
                      throws DaoException,
                             UserNotFoundException
インタフェース TemporaryUserDao の記述:
一時ユーザを取得する。

定義:
インタフェース TemporaryUserDao 内の getUser
パラメータ:
userGridId - ユーザのグリッドID
userId - 一時ユーザ名
戻り値:
一時ユーザ
例外:
DaoException - 処理に失敗した
UserNotFoundException - 指定されたユーザは存在しない