PagingBean (DBFlute Runtime 1.1.0-sp2-RC1 API)

すべてのスーパーインタフェース:

FetchBean, FetchNarrowingBean, OrderByBean

既知のサブインタフェースのリスト:

AutoPagingHandlingPmb<BEHAVIOR,ENTITY>, ConditionBean, ImmutableAutoPagingHandlingPmb<BEHAVIOR,IMMU,DBLE>, ImmutableManualPagingHandlingPmb<BEHAVIOR,IMMU,DBLE>, ManualPagingHandlingPmb<BEHAVIOR,ENTITY>, PagingHandlingPmb<BEHAVIOR,ENTITY>

既知の実装クラスのリスト:

AbstractConditionBean, SimplePagingBean
```
public interface PagingBean
extends FetchNarrowingBean, OrderByBean
```
The bean for paging.

作成者:

jflute

メソッドのサマリー

All Methods Instance Methods Abstract Methods
修飾子とタイプ	メソッドと説明
`boolean`	`canPagingCountLater()` Can the paging execute count later?
`boolean`	`canPagingReSelect()` Can the paging re-select?
`<ENTITY> PagingInvoker<ENTITY>`	`createPagingInvoker(String tableDbName)` Create the invoker of paging.
`void`	`disablePagingCountLater()` Disable paging count-later that means counting after selecting.
`void`	`disablePagingReSelect()` Disable paging re-select that is executed when the page number is over page count.
`void`	`enablePagingCountLater()` Enable paging count-later that means counting after selecting.
`void`	`enablePagingReSelect()` Enable paging re-select that is executed when the page number is over page count.
`PagingBean`	`fetchFirst(int fetchSize)` Fetch first records only.
`int`	`getFetchPageNumber()` Get fetch page number.
`int`	`getFetchSize()` Get fetch size of paging, also called page size.
`int`	`getFetchStartIndex()` Get fetch start index.
`int`	`getPageEndIndex()` Get page end index.
`int`	`getPageStartIndex()` Get page start index.
`boolean`	`isFetchScopeEffective()` Is fetch scope effective?
`boolean`	`isPaging()` Is the execution for paging(NOT count)?
`void`	`paging(int pageSize, int pageNumber)` Set up paging resources.
`PagingBean`	`xfetchPage(int fetchPageNumber)` Fetch page.
`PagingBean`	`xfetchScope(int fetchStartIndex, int fetchSize)` Fetch records in the scope only.
`void`	`xsetPaging(boolean paging)` Set whether the execution for paging(NOT count).

インタフェースから継承されたメソッド org.dbflute.cbean.paging.FetchNarrowingBean
getFetchNarrowingLoopCount, getFetchNarrowingSkipStartIndex, isFetchNarrowingEffective, isFetchNarrowingLoopCountEffective, isFetchNarrowingSkipStartIndexEffective, xdisableFetchNarrowing, xenableIgnoredFetchNarrowing

インタフェースから継承されたメソッド org.dbflute.jdbc.FetchBean
checkSafetyResult, getSafetyMaxResultSize

インタフェースから継承されたメソッド org.dbflute.cbean.ordering.OrderByBean
clearOrderBy, getOrderByClause, getOrderByComponent

- メソッドの詳細
  - isPaging
```
boolean isPaging()
```
    Is the execution for paging(NOT count)? {for parameter comment}
    
    戻り値:
    
    The determination, true or false.
  - canPagingCountLater
```
boolean canPagingCountLater()
```
    Can the paging execute count later? {for framework}
    
    戻り値:
    
    The determination, true or false.
  - canPagingReSelect
```
boolean canPagingReSelect()
```
    Can the paging re-select? {for framework}
    
    戻り値:
    
    The determination, true or false.
  - paging
```
void paging(int pageSize,
            int pageNumber)
```
    Set up paging resources.
```
 e.g. ConditionBean
 MemberCB cb = new MemberCB();
 cb.query().setMemberName_PrefixSearch("S");
 cb.query().addOrderBy_Birthdate_Desc();
 cb.paging(20, 3); // 20 records per a page and current page number is 3
 PagingResultBean<Member> page = memberBhv.selectPage(cb);
 
```
    パラメータ:
    
    pageSize - The page size per one page. (NotMinus, NotZero)
    
    pageNumber - The number of page. It's ONE origin. (NotMinus, NotZero: If it's minus or zero, it treats as one.)
    
    例外:
    
    PagingPageSizeNotPlusException - When the page size for paging is minus or zero.
  - xsetPaging
```
void xsetPaging(boolean paging)
```
    Set whether the execution for paging(NOT count). {INTERNAL METHOD}
    
    パラメータ:
    
    paging - Determination.
  - enablePagingCountLater
```
void enablePagingCountLater()
```
    Enable paging count-later that means counting after selecting. (back to default)
    You can use it by default on DBFlute so you don't need to call this basically. If you've suppressed it by settings of DBFlute property, you can use it by calling.
    You should call this before execution of selectPage().
  - disablePagingCountLater
```
void disablePagingCountLater()
```
    Disable paging count-later that means counting after selecting. (default is enabled)
    You should call this before execution of selectPage().
  - enablePagingReSelect
```
void enablePagingReSelect()
```
    Enable paging re-select that is executed when the page number is over page count. (back to default)
    You can use it by default on DBFlute so you don't need to call this basically. If you've suppressed it by settings of DBFlute property, you can use it by calling.
    You should call this before execution of selectPage().
  - disablePagingReSelect
```
void disablePagingReSelect()
```
    Disable paging re-select that is executed when the page number is over page count. (default is enabled)
    You should call this before execution of selectPage().
  - fetchFirst
```
PagingBean fetchFirst(int fetchSize)
```
    Fetch first records only. e.g. ConditionBean MemberCB cb = new MemberCB(); cb.query().setMemberName_PrefixSearch("S"); cb.query().addOrderBy_Birthdate_Desc(); cb.fetchFirst(5); // top 5 ListResultBean<Member> memberList = memberBhv.selectList(cb);
    
    パラメータ:
    
    fetchSize - The size of fetch. (NotMinus, NotZero)
    
    戻り値:
    
    this. (NotNull)
  - xfetchScope
```
PagingBean xfetchScope(int fetchStartIndex,
                       int fetchSize)
```
    Fetch records in the scope only. {Internal}
    This method is an old style, so you should use paging() instead of this.
    
    パラメータ:
    
    fetchStartIndex - The start index of fetch. 0 origin. (NotMinus)
    
    fetchSize - The size of fetch. (NotMinus, NotZero)
    
    戻り値:
    
    this. (NotNull)
  - xfetchPage
```
PagingBean xfetchPage(int fetchPageNumber)
```
    Fetch page. {Internal}
    This method is an old style, so you should use paging() instead of this.
    When you call this, it is normally necessary to invoke 'fetchFirst()' or 'fetchScope()' ahead of that.
    But you also can use default-fetch-size without invoking 'fetchFirst()' or 'fetchScope()'.
    If you invoke this, your SQL returns [fetch-size] records from [fetch-start-index] calculated by [fetch-page-number].
    
    パラメータ:
    
    fetchPageNumber - The page number of fetch. 1 origin. (NotMinus, NotZero: If minus or zero, set one.)
    
    戻り値:
    
    this. (NotNull)
  - createPagingInvoker
```
<ENTITY> PagingInvoker<ENTITY> createPagingInvoker(String tableDbName)
```
    Create the invoker of paging.
    
    型パラメータ:
    
    ENTITY - The type of entity.
    
    パラメータ:
    
    tableDbName - The DB name of table. (NotNull)
    
    戻り値:
    
    The instance of PagingInvoker for the table. (NotNull)
  - getFetchStartIndex
```
int getFetchStartIndex()
```
    Get fetch start index.
    
    戻り値:
    
    The index of fetch-start.
  - getFetchSize
```
int getFetchSize()
```
    Get fetch size of paging, also called page size.
    
    戻り値:
    
    The size of fetching rows.
  - getFetchPageNumber
```
int getFetchPageNumber()
```
    Get fetch page number.
    
    戻り値:
    
    The page number of fetch.
  - getPageStartIndex
```
int getPageStartIndex()
```
    Get page start index.
    
    戻り値:
    
    The index of page start, 0 origin. (NotMinus)
  - getPageEndIndex
```
int getPageEndIndex()
```
    Get page end index.
    
    戻り値:
    
    The index of page end, 0 origin. (NotMinus)
  - isFetchScopeEffective
```
boolean isFetchScopeEffective()
```
    Is fetch scope effective?
    
    戻り値:
    
    The determination, true or false.

インタフェース PagingBean

メソッドのサマリー

インタフェースから継承されたメソッド org.dbflute.cbean.paging.FetchNarrowingBean

インタフェースから継承されたメソッド org.dbflute.jdbc.FetchBean

インタフェースから継承されたメソッド org.dbflute.cbean.ordering.OrderByBean

メソッドの詳細

isPaging

canPagingCountLater

canPagingReSelect

paging

xsetPaging

enablePagingCountLater

disablePagingCountLater

enablePagingReSelect

disablePagingReSelect

fetchFirst

xfetchScope

xfetchPage

createPagingInvoker

getFetchStartIndex

getFetchSize

getFetchPageNumber

getPageStartIndex

getPageEndIndex

isFetchScopeEffective