DatatableRequest (OpenMRS 1.9.13-SNAPSHOT API)

java.lang.Object
- org.openmrs.web.controller.bean.DatatableRequest

```
public class DatatableRequest
extends java.lang.Object
```
Class dedicated for DataTables. It is a request that can be extracted from HttpServletRequest with parseRequest(HttpServletRequest).

See Also:

http://datatables.net/

Constructor Summary

Constructors
Constructor and Description

DatatableRequest()

Constructors
Constructor and Description
`DatatableRequest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Boolean`	`getbRegex()` True if the global filter should be treated as a regular expression for advanced filtering, false if not.
`java.lang.Boolean[]`	`getbRegexCol()` True if the individual column filter should be treated as a regular expression for advanced filtering, false if not.
`java.lang.Boolean[]`	`getbSearchableCol()` Indicator for if a column is flagged as searchable or not on the client-side.
`java.lang.Boolean[]`	`getbSortableCol()` Indicator for if a column is flagged as sortable or not on the client-side.
`java.lang.Integer`	`getiColumns()` Number of columns being displayed (useful for getting individual column search info).
`java.lang.Integer`	`getiDisplayLength()` Number of records that the table can display in the current draw.
`java.lang.Integer`	`getiDisplayStart()` Display start point in the current data set.
`java.lang.Integer[]`	`getiSortCol()` Column being sorted on (you will need to decode this number for your database).
`java.lang.Integer`	`getiSortingCols()` Number of columns to sort on.
`java.lang.String[]`	`getmDataPropCol()` The value specified by mDataProp for each column.
`java.lang.Integer`	`getsEcho()` Information for DataTables to use for rendering.
`java.lang.String`	`getsSearch()` Global search field.
`java.lang.String[]`	`getsSearchCol()` Individual column filter.
`java.lang.String[]`	`getsSortDirCol()` Direction to be sorted - "desc" or "asc".
`static DatatableRequest`	`parseRequest(javax.servlet.http.HttpServletRequest request)` Creates `DatatableRequest` from parameters found in the given request.
`void`	`setbRegex(java.lang.Boolean bRegex)`
`void`	`setbRegexCol(java.lang.Boolean[] bRegexCol)`
`void`	`setbSearchableCol(java.lang.Boolean[] bSearchableCol)`
`void`	`setbSortableCol(java.lang.Boolean[] bSortableCol)`
`void`	`setiColumns(java.lang.Integer iColumns)`
`void`	`setiDisplayLength(java.lang.Integer iDisplayLength)`
`void`	`setiDisplayStart(java.lang.Integer iDisplayStart)`
`void`	`setiSortCol(java.lang.Integer[] iSortCol)`
`void`	`setiSortingCols(java.lang.Integer iSortingCols)`
`void`	`setmDataPropCol(java.lang.String[] mDataPropCol)`
`void`	`setsEcho(java.lang.Integer sEcho)`
`void`	`setsSearch(java.lang.String sSearch)`
`void`	`setsSearchCol(java.lang.String[] sSearchCol)`
`void`	`setsSortDirCol(java.lang.String[] sSortDirCol)`

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

- Constructor Detail
  - DatatableRequest
```
public DatatableRequest()
```
- Method Detail
  - getiDisplayStart
```
public java.lang.Integer getiDisplayStart()
```
    Display start point in the current data set.
    
    Returns:
    
    the iDisplayStart
  - setiDisplayStart
```
public void setiDisplayStart(java.lang.Integer iDisplayStart)
```
    Parameters:
    
    iDisplayStart - the iDisplayStart to set
    
    See Also:
    
    getiDisplayStart()
  - getiDisplayLength
```
public java.lang.Integer getiDisplayLength()
```
    Number of records that the table can display in the current draw. It is expected that the number of records returned will be equal to this number, unless the server has fewer records to return.
    
    Returns:
    
    the iDisplayLength
  - setiDisplayLength
```
public void setiDisplayLength(java.lang.Integer iDisplayLength)
```
    Parameters:
    
    iDisplayLength - the iDisplayLength to set
    
    See Also:
    
    getiDisplayLength()
  - getiColumns
```
public java.lang.Integer getiColumns()
```
    Number of columns being displayed (useful for getting individual column search info).
    
    Returns:
    
    the iColumns
  - setiColumns
```
public void setiColumns(java.lang.Integer iColumns)
```
    Parameters:
    
    iColumns - the iColumns to set
    
    See Also:
    
    getiColumns()
  - getsSearch
```
public java.lang.String getsSearch()
```
    Global search field.
    
    Returns:
    
    the sSearch
  - setsSearch
```
public void setsSearch(java.lang.String sSearch)
```
    Parameters:
    
    sSearch - the sSearch to set
    
    See Also:
    
    getsSearch()
  - getbRegex
```
public java.lang.Boolean getbRegex()
```
    True if the global filter should be treated as a regular expression for advanced filtering, false if not.
    
    Returns:
    
    the bRegex
  - setbRegex
```
public void setbRegex(java.lang.Boolean bRegex)
```
    Parameters:
    
    bRegex - the bRegex to set
    
    See Also:
    
    getbRegex()
  - getbSearchableCol
```
public java.lang.Boolean[] getbSearchableCol()
```
    Indicator for if a column is flagged as searchable or not on the client-side.
    
    Returns:
    
    the bSearchableCol
  - setbSearchableCol
```
public void setbSearchableCol(java.lang.Boolean[] bSearchableCol)
```
    Parameters:
    
    bSearchableCol - the bSearchable to set
    
    See Also:
    
    getbSearchableCol()
  - getsSearchCol
```
public java.lang.String[] getsSearchCol()
```
    Individual column filter.
    
    Returns:
    
    the sSearchCol
  - setsSearchCol
```
public void setsSearchCol(java.lang.String[] sSearchCol)
```
    Parameters:
    
    sSearchCol - the sSearchColumn to set
    
    See Also:
    
    getsSearchCol()
  - getbRegexCol
```
public java.lang.Boolean[] getbRegexCol()
```
    True if the individual column filter should be treated as a regular expression for advanced filtering, false if not.
    
    Returns:
    
    the bRegexCol
  - setbRegexCol
```
public void setbRegexCol(java.lang.Boolean[] bRegexCol)
```
    Parameters:
    
    bRegexCol - the bRegexColumn to set
    
    See Also:
    
    getbRegexCol()
  - getbSortableCol
```
public java.lang.Boolean[] getbSortableCol()
```
    Indicator for if a column is flagged as sortable or not on the client-side.
    
    Returns:
    
    the bSortableCol
  - setbSortableCol
```
public void setbSortableCol(java.lang.Boolean[] bSortableCol)
```
    Parameters:
    
    bSortableCol - the bSortable to set
    
    See Also:
    
    getbSortableCol()
  - getiSortingCols
```
public java.lang.Integer getiSortingCols()
```
    Number of columns to sort on.
    
    Returns:
    
    the iSortingCols
  - setiSortingCols
```
public void setiSortingCols(java.lang.Integer iSortingCols)
```
    Parameters:
    
    iSortingCols - the iSortingCols to set
    
    See Also:
    
    getiSortingCols()
  - getiSortCol
```
public java.lang.Integer[] getiSortCol()
```
    Column being sorted on (you will need to decode this number for your database).
    
    Returns:
    
    the iSortCol
  - setiSortCol
```
public void setiSortCol(java.lang.Integer[] iSortCol)
```
    Parameters:
    
    iSortCol - the iSortCol to set
    
    See Also:
    
    getiSortCol()
  - getsSortDirCol
```
public java.lang.String[] getsSortDirCol()
```
    Direction to be sorted - "desc" or "asc".
    
    Returns:
    
    the sSortDirCol
  - setsSortDirCol
```
public void setsSortDirCol(java.lang.String[] sSortDirCol)
```
    Parameters:
    
    sSortDirCol - the sSortDir to set
    
    See Also:
    
    getsSortDirCol()
  - getmDataPropCol
```
public java.lang.String[] getmDataPropCol()
```
    The value specified by mDataProp for each column. This can be useful for ensuring that the processing of data is independent from the order of the columns.
    
    Returns:
    
    the mDataPropCol
  - setmDataPropCol
```
public void setmDataPropCol(java.lang.String[] mDataPropCol)
```
    Parameters:
    
    mDataPropCol - the mDataProp to set
    
    See Also:
    
    getmDataPropCol()
  - getsEcho
```
public java.lang.Integer getsEcho()
```
    Information for DataTables to use for rendering.
    
    Returns:
    
    the sEcho
  - setsEcho
```
public void setsEcho(java.lang.Integer sEcho)
```
    Parameters:
    
    sEcho - the sEcho to set
    
    See Also:
    
    getsEcho()
  - parseRequest
```
public static DatatableRequest parseRequest(javax.servlet.http.HttpServletRequest request)
```
    Creates DatatableRequest from parameters found in the given request.
    
    Parameters:
    
    request -
    
    Returns:
    
    DatatableRequest

Class DatatableRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DatatableRequest

Method Detail

getiDisplayStart

setiDisplayStart

getiDisplayLength

setiDisplayLength

getiColumns

setiColumns

getsSearch

setsSearch

getbRegex

setbRegex

getbSearchableCol

setbSearchableCol

getsSearchCol

setsSearchCol

getbRegexCol

setbRegexCol

getbSortableCol

setbSortableCol

getiSortingCols

setiSortingCols

getiSortCol

setiSortCol

getsSortDirCol

setsSortDirCol

getmDataPropCol

setmDataPropCol

getsEcho

setsEcho

parseRequest