Changeset 15114 for platform/eclipse/sabotter/trunk/jp.xet.sabotter.core/src/jp/xet/sabotter/core/MiniblogService.java

Timestamp:

07/03/08 19:49:47 (5 months ago)

Author:

yamashiro

Message:

不正なid/パスワードのときに固まる問題が再現したので修正した。また、その際に、userNameなどをuserIdに統一するようにリファクタリングしたり、その他のリファクタを行った

Files:

• platform/eclipse/sabotter/trunk/jp.xet.sabotter.core/src/jp/xet/sabotter/core/MiniblogService.java (modified) (3 diffs)

platform/eclipse/sabotter/trunk/jp.xet.sabotter.core/src/jp/xet/sabotter/core/MiniblogService.java

@@ -4 +4 @@
 
 /**
- * さぼったーコアインタフェース
+ * 各ミニblogサービスを表すインタフェースです。 各メソッドについて、サービスごとに差異があるため、未実装であったり、null などが返却されることがあります。
  * 
- * @author Ewigkeit
+ * @author Ewigkeit yamashiro
  */
 public interface MiniblogService {
@@ -12 +12 @@
         /**
          * サービス識別子を取得する。
+         * 
          * @return サービス識別子
          */
@@ -17 +18 @@
         
         /**
-         * ログイン用にユーザIDを設定する。
+         * アカウント情報の初期設定を設定します。 このメソッドは「初期設定」に使われます。 初期設定後にアカウント情報を変更する場合には、 changeAccountメソッドを利用します。 サービスによっては、設定した
+         * 
          * @param userId ユーザID
+         * @param password パスワード
          */
-        public void setUserId(String userId);
+        public void setAccount(String userId, String password);
         
         /**
-         * ログイン用にパスワードを設定する。
+         * アカウント情報の変更を行います。
+         * 
+         * @param userId ユーザId
+         * 
          * @param password パスワード
          */
-        public void setPassword(String password);
+        void changeAccount(String userId, String password);
         
-        void createFavorite(String id, MiniblogServiceResponceListener listener);
+        /**
+         * favorite を行います。 favorite 機能が実装されていないサービスでは何も行われません
+         * 
+         * @param statusId favorite状態にしたいステータスのID
+         * @param listener favorite 機能が実装されている場合に、favoriteが終了した後に呼ばれるリスナです
+         */
+        void createFavorite(String statusId, MiniblogServiceResponceListener listener);
         
+        /**
+         * タイムラインの取得を行います。 タイムライン取得機能が実装されていないサービスでは何も行われません
+         * 
+         * @param listener タイムラインの取得機能が実装されている場合に、タイムラインの取得が終了した後に呼ばれるリスナです
+         */
         void getFriendsTimeline(MiniblogServiceResponceListener listener);
         
+        /**
+         * リプライの取得を行います。 リプライ取得機能が実装されていないサービスでは何も行われません
+         * 
+         * @param listener リプライの取得機能が実装されている場合に、リプライの取得が終了した後に呼ばれるリスナです
+         */
         void getReplies(MiniblogServiceResponceListener listener);
         
+        /**
+         * ダイレクトメッセージの取得を行います。 ダイレクトメッセージ取得機能が実装されていないサービスでは何も行われません
+         * 
+         * @param listener ダイレクトメッセージの取得機能が実装されている場合に、ダイレクトメッセージの取得が終了した後に呼ばれるリスナです
+         */
         void getDirectMessages(MiniblogServiceResponceListener listener);
         
+        /**
+         * 発言を行います。
+         * 
+         * @param statusText 発言したい内容
+         * @return 発言した内容をエントリーとして返せるサービスの場合エントリー。返せない場合 null が返ります。
+         * @throws MiniblogServiceException サービスで例外が発生した際に発生します。
+         */
         MiniblogEntry update(String statusText) throws MiniblogServiceException;
         
-        MiniblogUser getUser(String screenName);
+        /**
+         * 指定されたユーザ情報を返します。
+         * 
+         * @param userId ユーザId
+         * @return ユーザ情報
+         */
+        MiniblogUser getUser(String userId);
         
-        void changeAccount(String username, String password);
 }