Package nablarch.core.db.support
Class ListSearchInfo
java.lang.Object
nablarch.core.db.support.ListSearchInfo
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
Pagination
一覧検索用の情報を保持する基底クラス。
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected final Integer
getConfigValue
(String name) SystemRepository
から設定値を取得する。final int
検索結果の取得終了位置を取得する。final int
最初のページ番号を取得する。final boolean
次のページが存在するか否かを取得する。final boolean
前のページが存在するか否かを取得する。final int
最終ページの番号を取得する。final Integer
getMax()
1ページあたりの最大取得件数を取得する。final int
検索結果の最大件数(上限)を取得する。final int
次のページ番号を取得する。final int
総ページ数を取得する。final Integer
取得対象のページ番号を取得する。final int
前のページ番号を取得する。final int
検索結果の総件数を取得する。abstract String[]
検索条件のプロパティ名を取得する。final String
ソートIDを取得する。final int
検索結果の取得開始位置を取得する。void
1ページあたりの最大取得件数を設定する。void
setMaxResultCount
(int maxResultCount) 検索結果の最大件数(上限)を設定する。void
setPageNumber
(Integer pageNumber) 取得対象のページ番号を設定する。final void
setResultCount
(int resultCount) 検索結果の総件数を設定する。 本メソッドはフレームワークが検索処理を実行後に取得結果の総件数を設定するものである。 アプリケーション側では、本メソッドを使用して値の設定は行わないこと。void
ソートIDを設定する。
-
Constructor Details
-
ListSearchInfo
protected ListSearchInfo()SystemRepository
の設定値を元にListSearchInfo
を生成する。下記の初期化処理を行う。 検索結果の最大件数(上限): リポジトリの設定値(nablarch.listSearch.maxResultCount)を取得して設定する。 リポジトリの設定値が存在しない場合は、200を設定する。 検索結果のページ番号: 1を設定する。 1ページあたりの最大取得件数: リポジトリの設定値(nablarch.listSearch.max)を取得して設定する。 リポジトリの設定値が存在しない場合は、20を設定する。
-
-
Method Details
-
getConfigValue
SystemRepository
から設定値を取得する。- Parameters:
name
- 設定名- Returns:
- 設定値。存在しない場合はnull
-
getSearchConditionProps
検索条件のプロパティ名を取得する。- Returns:
- 検索条件のプロパティ名
-
getPageNumber
取得対象のページ番号を取得する。- Returns:
- 取得対象のページ番号
-
setPageNumber
取得対象のページ番号を設定する。- Parameters:
pageNumber
- 取得対象のページ番号
-
getStartPosition
public final int getStartPosition()検索結果の取得開始位置を取得する。- Returns:
- 検索結果の取得開始位置
-
getEndPosition
public final int getEndPosition()検索結果の取得終了位置を取得する。検索結果の総件数が現在のページ番号に対する最大取得終了位置に満たない場合は、 検索結果の総件数を返す。 検索結果の総件数が現在のページ番号に対する最大取得終了位置以上の場合は、 現在のページ番号に対する最大取得終了位置を返す。
- Returns:
- 検索結果の取得終了位置
-
getMax
1ページあたりの最大取得件数を取得する。- Returns:
- 1ページあたりの最大取得件数
-
setMax
1ページあたりの最大取得件数を設定する。- Parameters:
max
- 1ページあたりの最大取得件数
-
getResultCount
public final int getResultCount()検索結果の総件数を取得する。- Returns:
- 検索結果の総件数
-
setResultCount
public final void setResultCount(int resultCount) 検索結果の総件数を設定する。 本メソッドはフレームワークが検索処理を実行後に取得結果の総件数を設定するものである。 アプリケーション側では、本メソッドを使用して値の設定は行わないこと。- Parameters:
resultCount
- 検索結果の総件数
-
getMaxResultCount
public final int getMaxResultCount()検索結果の最大件数(上限)を取得する。- Returns:
- 検索結果の最大件数(上限)
-
setMaxResultCount
public void setMaxResultCount(int maxResultCount) 検索結果の最大件数(上限)を設定する。- Parameters:
maxResultCount
- 検索結果の最大件数(上限)
-
getSortId
ソートIDを取得する。- Returns:
- ソートID
-
setSortId
ソートIDを設定する。- Parameters:
sortId
- ソートID
-
getHasPrevPage
public final boolean getHasPrevPage()前のページが存在するか否かを取得する。- Returns:
- 前のページが存在する場合は
true
-
getHasNextPage
public final boolean getHasNextPage()次のページが存在するか否かを取得する。- Returns:
- 次のページが存在する場合は
true
-
getPageCount
public final int getPageCount()総ページ数を取得する。- Returns:
- 総ページ数
-
getFirstPageNumber
public final int getFirstPageNumber()最初のページ番号を取得する。- Returns:
- 最初のページ番号
-
getPrevPageNumber
public final int getPrevPageNumber()前のページ番号を取得する。- Returns:
- 前のページ番号
-
getNextPageNumber
public final int getNextPageNumber()次のページ番号を取得する。- Returns:
- 次のページ番号
-
getLastPageNumber
public final int getLastPageNumber()最終ページの番号を取得する。- Returns:
- 最終ページの番号
-