クラス GenreSearch
- java.lang.Object
-
- com.sdk.java.dmm.api.AbstractDmm<GenreSearchResult>
-
- com.sdk.java.dmm.api.genre.GenreSearch
-
public class GenreSearch extends AbstractDmm<GenreSearchResult>
ジャンル検索を実行するためのクラスです。
使用するにあたって下記の事項に注意してください。
フロアIDは必須です。
下記は使用方法になります。
GenreSearch genreSearch = new GenreSearch(); genreSearch.setFloorId(40); GenreSearchResult result = genreSearch.execute();
-
-
コンストラクタの概要
コンストラクタ コンストラクタ 説明 GenreSearch(String apiId, String affiliateId)
ジャンル検索オブジェクトを生成します。
-
メソッドの概要
すべてのメソッド インスタンス・メソッド concreteメソッド 修飾子とタイプ メソッド 説明 void
clear()
パラメータをクリアする。protected BaseURL
getBaseURL()
DMM_APIを実行するためのURLを管理する列挙型を返却する。protected String
getParam()
APIを実行するためのパラメータを取得する。protected Class<GenreSearchResult>
getResultClass()
JSONとマッピングされるDTOのクラスオブジェクトを取得する。private void
paramCheck()
パラメータの相関チェックを行う。GenreSearch
setFloorId(String floorId)
フロアIDを設定する。GenreSearch
setHits(Integer hits)
取得件数を設定する。GenreSearch
setInitial(String initial)
ジャンルの頭文字を設定する。GenreSearch
setOffset(Long offset)
検索開始位置を設定する。-
クラスから継承されたメソッド com.sdk.java.dmm.api.AbstractDmm
execute, getJson
-
-
-
-
メソッドの詳細
-
setFloorId
public GenreSearch setFloorId(String floorId)
フロアIDを設定する。
フロア検索APIから取得可能なフロアID- パラメータ:
floorId
- フロアID- 戻り値:
- this GenreSearch
-
setInitial
public GenreSearch setInitial(String initial) throws DmmIllegalArgumentException
ジャンルの頭文字を設定する。
50音をUTF-8で指定。
例:あい- パラメータ:
initial
- 頭文字- 戻り値:
- this GenreSearch
- 例外:
DmmIllegalArgumentException
- 引数が不正な場合にスローされる
-
setHits
public GenreSearch setHits(Integer hits)
取得件数を設定する。
初期値:100 最大:500- パラメータ:
hits
- 取得件数- 戻り値:
- this GenreSearch
-
setOffset
public GenreSearch setOffset(Long offset)
検索開始位置を設定する。
初期値:1- パラメータ:
offset
- 検索開始位置- 戻り値:
- this GenreSearch
-
clear
public void clear()
パラメータをクリアする。- 定義:
clear
クラス内AbstractDmm<GenreSearchResult>
-
getParam
protected String getParam()
APIを実行するためのパラメータを取得する。- 定義:
getParam
クラス内AbstractDmm<GenreSearchResult>
- 戻り値:
- パラメータ
-
getBaseURL
protected BaseURL getBaseURL()
DMM_APIを実行するためのURLを管理する列挙型を返却する。- 定義:
getBaseURL
クラス内AbstractDmm<GenreSearchResult>
- 戻り値:
- BaseURL ベースURL
-
getResultClass
protected Class<GenreSearchResult> getResultClass()
JSONとマッピングされるDTOのクラスオブジェクトを取得する。- 定義:
getResultClass
クラス内AbstractDmm<GenreSearchResult>
- 戻り値:
- クラスオブジェクト
-
paramCheck
private void paramCheck() throws DmmIllegalParameterException
パラメータの相関チェックを行う。
入力値が不正な場合は、DmmIllegalParameterException
をスローする。- 例外:
DmmIllegalParameterException
- パラメータが不正な場合にスローされる
-
-