ListSearchInfo (Nablarch-API)

java.lang.Object
- nablarch.core.db.support.ListSearchInfo

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Pagination
```
@Published
public abstract class ListSearchInfo
extends java.lang.Object
implements java.io.Serializable
```
一覧検索用の情報を保持する基底クラス。

See Also:

DbAccessSupport.search(String, ListSearchInfo), Serialized Form

Constructor Summary

Constructors
Modifier Constructor and Description

protected ListSearchInfo()
SystemRepositoryの設定値を元にListSearchInfoを生成する。

Constructors
Modifier	Constructor and Description
`protected`	`ListSearchInfo()` `SystemRepository`の設定値を元に`ListSearchInfo`を生成する。

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.lang.Integer`	`getConfigValue(java.lang.String name)` `SystemRepository`から設定値を取得する。
`int`	`getEndPosition()` 検索結果の取得終了位置を取得する。
`int`	`getFirstPageNumber()` 最初のページ番号を取得する。
`boolean`	`getHasNextPage()` 次のページが存在するか否かを取得する。
`boolean`	`getHasPrevPage()` 前のページが存在するか否かを取得する。
`int`	`getLastPageNumber()` 最終ページの番号を取得する。
`java.lang.Integer`	`getMax()` 1ページあたりの最大取得件数を取得する。
`int`	`getMaxResultCount()` 検索結果の最大件数(上限)を取得する。
`int`	`getNextPageNumber()` 次のページ番号を取得する。
`int`	`getPageCount()` 総ページ数を取得する。
`java.lang.Integer`	`getPageNumber()` 取得対象のページ番号を取得する。
`int`	`getPrevPageNumber()` 前のページ番号を取得する。
`int`	`getResultCount()` 検索結果の総件数を取得する。
`abstract java.lang.String[]`	`getSearchConditionProps()` 検索条件のプロパティ名を取得する。
`java.lang.String`	`getSortId()` ソートIDを取得する。
`int`	`getStartPosition()` 検索結果の取得開始位置を取得する。
`void`	`setMax(java.lang.Integer max)` 1ページあたりの最大取得件数を設定する。
`void`	`setMaxResultCount(int maxResultCount)` 検索結果の最大件数(上限)を設定する。
`void`	`setPageNumber(java.lang.Integer pageNumber)` 取得対象のページ番号を設定する。
`void`	`setResultCount(int resultCount)` 検索結果の総件数を設定する。本メソッドはフレームワークが検索処理を実行後に取得結果の総件数を設定するものである。アプリケーション側では、本メソッドを使用して値の設定は行わないこと。
`void`	`setSortId(java.lang.String sortId)` ソートIDを設定する。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ListSearchInfo
```
protected ListSearchInfo()
```
    SystemRepositoryの設定値を元にListSearchInfoを生成する。
```
 下記の初期化処理を行う。
 
 検索結果の最大件数(上限)：
     リポジトリの設定値(nablarch.listSearch.maxResultCount)を取得して設定する。
     リポジトリの設定値が存在しない場合は、200を設定する。
 
 検索結果のページ番号：
     1を設定する。
 
 1ページあたりの最大取得件数：
     リポジトリの設定値(nablarch.listSearch.max)を取得して設定する。
     リポジトリの設定値が存在しない場合は、20を設定する。
 
```
- Method Detail
  - getConfigValue
```
protected final java.lang.Integer getConfigValue(java.lang.String name)
```
    SystemRepositoryから設定値を取得する。
    
    Parameters:
    
    name - 設定名
    
    Returns:
    
    設定値。存在しない場合はnull
  - getSearchConditionProps
```
public abstract java.lang.String[] getSearchConditionProps()
```
    検索条件のプロパティ名を取得する。
    
    Returns:
    
    検索条件のプロパティ名
  - getPageNumber
```
public final java.lang.Integer getPageNumber()
```
    取得対象のページ番号を取得する。
    
    Returns:
    
    取得対象のページ番号
  - setPageNumber
```
public void setPageNumber(java.lang.Integer pageNumber)
```
    取得対象のページ番号を設定する。
    
    Parameters:
    
    pageNumber - 取得対象のページ番号
  - getStartPosition
```
public final int getStartPosition()
```
    検索結果の取得開始位置を取得する。
    
    Returns:
    
    検索結果の取得開始位置
  - getEndPosition
```
public final int getEndPosition()
```
    検索結果の取得終了位置を取得する。
```
 検索結果の総件数が現在のページ番号に対する最大取得終了位置に満たない場合は、
 検索結果の総件数を返す。
 
 検索結果の総件数が現在のページ番号に対する最大取得終了位置以上の場合は、
 現在のページ番号に対する最大取得終了位置を返す。
 
```
    Returns:
    
    検索結果の取得終了位置
  - getMax
```
public final java.lang.Integer getMax()
```
    1ページあたりの最大取得件数を取得する。
    
    Returns:
    
    1ページあたりの最大取得件数
  - setMax
```
public void setMax(java.lang.Integer max)
```
    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
```
public final java.lang.String getSortId()
```
    ソートIDを取得する。
    
    Returns:
    
    ソートID
  - setSortId
```
public void setSortId(java.lang.String sortId)
```
    ソート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:
    
    最終ページの番号

Class ListSearchInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ListSearchInfo

Method Detail

getConfigValue

getSearchConditionProps

getPageNumber

setPageNumber

getStartPosition

getEndPosition

getMax

setMax

getResultCount

setResultCount

getMaxResultCount

setMaxResultCount

getSortId

setSortId

getHasPrevPage

getHasNextPage

getPageCount

getFirstPageNumber

getPrevPageNumber

getNextPageNumber

getLastPageNumber