パッケージ com.sdk.java.dmm.api.author

クラス AuthorSearch

  • public class AuthorSearch
extends AbstractDmm<AuthorSearchResult>

    作者検索を実行するためのクラスです。
    使用するにあたって下記の事項に注意してください。
    フロアIDは必須です。

    下記は使用方法になります。 

     AuthorSearch authorSearch = new AuthorSearch();
 authorSearch.setFloorId(43);
 AuthorSearchResult result = authorSearch.execute();

    • フィールドの詳細

      • floorId

        public String floorId
        フロアID

      • initial

        public String initial
        作者名の頭文字(50音)

      • hits

        public Integer hits
        取得件数

      • offset

        public Long offset
        検索開始位置

    • コンストラクタの詳細

      • AuthorSearch

        public AuthorSearch​(String apiId,
                    String affiliateId)
        作者検索オブジェクトを生成します。
        パラメータ:
        apiId - API_ID
        affiliateId - AFFILIATE_ID

    • メソッドの詳細

      • setFloorId

        public AuthorSearch setFloorId​(String floorId)
        フロアIDを設定する。
        フロア検索APIから取得可能なフロアID
        パラメータ:
        floorId - フロアID
        戻り値:
        this GenreSearch

      • setHits

        public AuthorSearch setHits​(Integer hits)
        取得件数を設定する。
        初期値：100　最大：500
        パラメータ:
        hits - 取得件数
        戻り値:
        this GenreSearch

      • setOffset

        public AuthorSearch setOffset​(Long offset)
        検索開始位置を設定する。
        初期値：1
        パラメータ:
        offset - 検索開始位置
        戻り値:
        this GenreSearch

      • paramCheck

        private void paramCheck()
                 throws DmmIllegalParameterException
        パラメータの相関チェックを行う。
        入力値が不正な場合は、DmmIllegalParameterExceptionをスローする。
        例外:
        DmmIllegalParameterException - パラメータが不正な場合にスローされる