Package nablarch.core.db.support

Class ListSearchInfo

java.lang.Object
nablarch.core.db.support.ListSearchInfo
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
Pagination
@Published public abstract class ListSearchInfo extends Object implements Serializable
一覧検索用の情報を保持する基底クラス。
See Also:

  • Constructor Details

    • ListSearchInfo

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

       下記の初期化処理を行う。
 
 検索結果の最大件数(上限)：
     リポジトリの設定値(nablarch.listSearch.maxResultCount)を取得して設定する。
     リポジトリの設定値が存在しない場合は、200を設定する。
 
 検索結果のページ番号：
     1を設定する。
 
 1ページあたりの最大取得件数：
     リポジトリの設定値(nablarch.listSearch.max)を取得して設定する。
     リポジトリの設定値が存在しない場合は、20を設定する。

  • Method Details

    • getConfigValue

      protected final Integer getConfigValue(String name)
      SystemRepositoryから設定値を取得する。
      Parameters:
      name - 設定名
      Returns:
      設定値。存在しない場合はnull

    • getSearchConditionProps

      public abstract String[] getSearchConditionProps()
      検索条件のプロパティ名を取得する。
      Returns:
      検索条件のプロパティ名

    • getPageNumber

      public final Integer getPageNumber()
      取得対象のページ番号を取得する。
      Returns:
      取得対象のページ番号

    • setPageNumber

      public void setPageNumber(Integer pageNumber)
      取得対象のページ番号を設定する。
      Parameters:
      pageNumber - 取得対象のページ番号

    • getStartPosition

      public final int getStartPosition()
      検索結果の取得開始位置を取得する。
      Returns:
      検索結果の取得開始位置

    • getEndPosition

      public final int getEndPosition()
      検索結果の取得終了位置を取得する。 
       検索結果の総件数が現在のページ番号に対する最大取得終了位置に満たない場合は、
 検索結果の総件数を返す。
 
 検索結果の総件数が現在のページ番号に対する最大取得終了位置以上の場合は、
 現在のページ番号に対する最大取得終了位置を返す。
      Returns:
      検索結果の取得終了位置

    • getMax

      public final Integer getMax()
      1ページあたりの最大取得件数を取得する。
      Returns:
      1ページあたりの最大取得件数

    • setMax

      public void setMax(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 String getSortId()
      ソートIDを取得する。
      Returns:
      ソートID

    • setSortId

      public void setSortId(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:
      最終ページの番号