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

クラス SeriesSearch

java.lang.Object

com.sdk.java.dmm.api.AbstractDmm<SeriesSearchResult>

com.sdk.java.dmm.api.series.SeriesSearch

public class SeriesSearch
extends AbstractDmm<SeriesSearchResult>

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

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

 SeriesSearch seriesSearch = new SeriesSearch();
 seriesSearch.setFloorId(43);
 SeriesSearchResult result = seriesSearch.execute();
 

フィールドの概要

フィールド

修飾子とタイプ	フィールド	説明
String	floorId	フロアID
Integer	hits	取得件数
String	initial	シリーズ名の頭文字(50音)
Long	offset	検索開始位置

コンストラクタの概要

コンストラクタ

コンストラクタ	説明
SeriesSearch(String apiId, String affiliateId)	シリーズ検索オブジェクトを生成します。

メソッドの概要

修飾子とタイプ	メソッド	説明
void	clear()	パラメータをクリアする。
protected BaseURL	getBaseURL()	DMM_APIを実行するためのURLを管理する列挙型を返却する。
protected String	getParam()	APIを実行するためのパラメータを取得する。
protected Class<SeriesSearchResult>	getResultClass()	JSONとマッピングされるDTOのクラスオブジェクトを取得する。
private void	paramCheck()	パラメータの相関チェックを行う。
SeriesSearch	setFloorId(String floorId)	フロアIDを設定する。
SeriesSearch	setHits(Integer hits)	取得件数を設定する。
SeriesSearch	setInitial(String initial)	作者の頭文字を設定する。
SeriesSearch	setOffset(Long offset)	検索開始位置を設定する。

クラスから継承されたメソッド com.sdk.java.dmm.api.AbstractDmm

execute, getJson

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

floorId

public String floorId

フロアID

initial

public String initial

シリーズ名の頭文字(50音)

hits

public Integer hits

取得件数

offset

public Long offset

検索開始位置

コンストラクタの詳細

SeriesSearch

public SeriesSearch(String apiId,
                    String affiliateId)

シリーズ検索オブジェクトを生成します。

パラメータ:

apiId - API_ID

affiliateId - AFFILIATE_ID

メソッドの詳細

setFloorId

public SeriesSearch setFloorId(String floorId)

フロアIDを設定する。
フロア検索APIから取得可能なフロアID

パラメータ:

floorId - フロアID

戻り値:

this SeriesSearch

setInitial

public SeriesSearch setInitial(String initial)
                        throws DmmIllegalArgumentException

作者の頭文字を設定する。
50音をUTF-8で指定。
例:あい

パラメータ:

initial - 頭文字

戻り値:

this SeriesSearch

例外:

DmmIllegalArgumentException - 引数が不正な場合にスローされる

setHits

public SeriesSearch setHits(Integer hits)

取得件数を設定する。
初期値：100　最大：500

パラメータ:

hits - 取得件数

戻り値:

this SeriesSearch

setOffset

public SeriesSearch setOffset(Long offset)

検索開始位置を設定する。
初期値：1

パラメータ:

offset - 検索開始位置

戻り値:

this SeriesSearch

clear

public void clear()

パラメータをクリアする。

定義:

clear クラス内 AbstractDmm<SeriesSearchResult>

getParam

protected String getParam()

APIを実行するためのパラメータを取得する。

定義:

getParam クラス内 AbstractDmm<SeriesSearchResult>

戻り値:

パラメータ

getBaseURL

protected BaseURL getBaseURL()

DMM_APIを実行するためのURLを管理する列挙型を返却する。

定義:

getBaseURL クラス内 AbstractDmm<SeriesSearchResult>

戻り値:

BaseURL ベースURL

getResultClass

protected Class<SeriesSearchResult> getResultClass()

JSONとマッピングされるDTOのクラスオブジェクトを取得する。

定義:

getResultClass クラス内 AbstractDmm<SeriesSearchResult>

戻り値:

クラスオブジェクト

paramCheck

private void paramCheck()
                 throws DmmIllegalParameterException

パラメータの相関チェックを行う。
入力値が不正な場合は、DmmIllegalParameterExceptionをスローする。

例外:

DmmIllegalParameterException - パラメータが不正な場合にスローされる