TabularReport

java.lang.Object
- com.cloupia.model.cIM.TabularReport

All Implemented Interfaces:

java.io.Serializable
```
public class TabularReport
extends java.lang.Object
implements java.io.Serializable
```
The model class represents the Tabular report. This is a serializable object with fields that can be accessed to make the report custamizable

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int[]`	`VIEW__OPTIONS_TABULAR_AND_TILE`
`static int[]`	`VIEW__OPTIONS_TABULAR_ONLY`
`static int[]`	`VIEW__OPTIONS_TILE_AND_TABULAR`
`static int[]`	`VIEW__OPTIONS_TILE_ONLY`
`static int`	`VIEW_TABULAR`
`static int`	`VIEW_TILE`

Constructor Summary

Constructors
Constructor and Description

TabularReport()
Empty constructor to create the TabularReport object

Constructors
Constructor and Description
`TabularReport()` Empty constructor to create the TabularReport object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAppliedToFolderFlagIndex()` Returns the applied to folder flag's index
`int`	`getAutoRefreshSeconds()` Returns the autoRefreshInSeconds
`ColumnDefinition[]`	`getColumnDefinitions()` Return the column definitions
`ReportContext`	`getContext()` Returns the context
`TabularReportCustomSpec[]`	`getCustomSpec()` Returns the tabularReportCustomSpec
`int`	`getFolderColumnIndex()` Returns the folderColumnIndex
`long`	`getGeneratedTime()` Returns the generated time
`java.lang.String[]`	`getGroupOrder()` Returns the group Order
`java.lang.String`	`getMessageOnNoData()` Returns the messageOnNoData
`int[]`	`getRefreshIdColumnIndices()` Returns the refreshIdColumnIndices
`java.lang.String`	`getReportName()` Returns the reportName
`RowData[]`	`getRows()` Returns the rows
`TileView`	`getTileView()` Returns the TileView
`int`	`getTotalRowCount()` Returns the totalRowCount
`UITreeNodeDefinition[]`	`getUiTreeNodeDefinitions()` Returns the UITreeNodeDefinitions
`int[]`	`getViews()` Returns the views
`boolean`	`isAutoSortFolders()` Retuns the autoSortFolders
`void`	`setAppliedToFolderFlagIndex(int appliedToFolderFlagIndex)` Setter method to set the appliedToFolderFlagIndex
`void`	`setAutoRefreshSeconds(int autoRefreshSeconds)` The autoRefreshSeconds to set
`void`	`setAutoSortFolders(boolean autoSortFolders)` Indicates uiTreeNodeDefinitions folders shall be sorted by default
`void`	`setColumnDefinitions(ColumnDefinition[] columnDefinitions)` The columnDefinitions to set
`void`	`setContext(ReportContext context)` The context to set
`void`	`setCustomSpec(TabularReportCustomSpec[] customSpec)` The customSpec to set
`void`	`setFolderColumnIndex(int folderColumnIndex)` Set the folderColumnIndex
`void`	`setGeneratedTime(long generatedTime)` The generatedTime to set
`void`	`setGroupOrder(java.lang.String[] groupOrder)` The groupOrder to set
`void`	`setMessageOnNoData(java.lang.String messageOnNoData)`
`void`	`setRefreshIdColumnIndices(int[] refreshIdColumnIndices)` Set the refreshIdColumnIndices
`void`	`setReportName(java.lang.String reportName)` Set the Report Name.
`void`	`setRows(RowData[] rows)` The rows to set
`void`	`setTableAndTileView()` Set tableAndTileView flag
`void`	`setTabularOnlyView()` Set tabularViewOnly flag
`void`	`setTileAndTableView()` Set tileAndTableView flag
`void`	`setTileOnlyView()` Set the tileViewOnly flag
`void`	`setTileView(TileView tileView)` Set the fileView
`void`	`setTotalRowCount(int totalRowCount)` Set the totalRowcount
`void`	`setUiTreeNodeDefinitions(UITreeNodeDefinition[] uiTreeNodeDefinitions)` Setter method for uiTreeNodeDefinitions
`void`	`setViews(int[] views)` Set the views

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

- Field Detail
  - VIEW_TABULAR
```
public static final int VIEW_TABULAR
```
    See Also:
    
    Constant Field Values
  - VIEW_TILE
```
public static final int VIEW_TILE
```
    See Also:
    
    Constant Field Values
  - VIEW__OPTIONS_TABULAR_ONLY
```
public static final int[] VIEW__OPTIONS_TABULAR_ONLY
```
  - VIEW__OPTIONS_TILE_ONLY
```
public static final int[] VIEW__OPTIONS_TILE_ONLY
```
  - VIEW__OPTIONS_TABULAR_AND_TILE
```
public static final int[] VIEW__OPTIONS_TABULAR_AND_TILE
```
  - VIEW__OPTIONS_TILE_AND_TABULAR
```
public static final int[] VIEW__OPTIONS_TILE_AND_TABULAR
```
- Constructor Detail
  - TabularReport
```
public TabularReport()
```
    Empty constructor to create the TabularReport object
- Method Detail
  - getAppliedToFolderFlagIndex
```
public int getAppliedToFolderFlagIndex()
```
    Returns the applied to folder flag's index
    
    Returns:
    
    the index of the appliedToFolderFlag
  - setAppliedToFolderFlagIndex
```
public void setAppliedToFolderFlagIndex(int appliedToFolderFlagIndex)
```
    Setter method to set the appliedToFolderFlagIndex
    
    Parameters:
    
    appliedToFolderFlagIndex -
  - getUiTreeNodeDefinitions
```
public UITreeNodeDefinition[] getUiTreeNodeDefinitions()
```
    Returns the UITreeNodeDefinitions
    
    Returns:
    
    - the UITreeNodeDefinitions
  - setUiTreeNodeDefinitions
```
public void setUiTreeNodeDefinitions(UITreeNodeDefinition[] uiTreeNodeDefinitions)
```
    Setter method for uiTreeNodeDefinitions
    
    Parameters:
    
    uiTreeNodeDefinitions - - the uiTreeNodeDefinitions to be set
  - getReportName
```
public java.lang.String getReportName()
```
    Returns the reportName
    
    Returns:
    
    the reportName
  - setReportName
```
public void setReportName(java.lang.String reportName)
```
    Set the Report Name.
    
    Parameters:
    
    reportName -
  - getContext
```
public ReportContext getContext()
```
    Returns the context
    
    Returns:
    
    the context
  - setContext
```
public void setContext(ReportContext context)
```
    The context to set
    
    Parameters:
    
    context -
  - getGeneratedTime
```
public long getGeneratedTime()
```
    Returns the generated time
    
    Returns:
    
    the generatedTime
  - setGeneratedTime
```
public void setGeneratedTime(long generatedTime)
```
    The generatedTime to set
    
    Parameters:
    
    generatedTime -
  - getColumnDefinitions
```
public ColumnDefinition[] getColumnDefinitions()
```
    Return the column definitions
    
    Returns:
    
    the columnDefinitions
  - setColumnDefinitions
```
public void setColumnDefinitions(ColumnDefinition[] columnDefinitions)
```
    The columnDefinitions to set
    
    Parameters:
    
    columnDefinitions -
  - getRows
```
public RowData[] getRows()
```
    Returns the rows
    
    Returns:
    
    the rows
  - setRows
```
public void setRows(RowData[] rows)
```
    The rows to set
    
    Parameters:
    
    rows -
  - getCustomSpec
```
public TabularReportCustomSpec[] getCustomSpec()
```
    Returns the tabularReportCustomSpec
    
    Returns:
    
    the customSpec
  - setCustomSpec
```
public void setCustomSpec(TabularReportCustomSpec[] customSpec)
```
    The customSpec to set
    
    Parameters:
    
    customSpec -
  - getGroupOrder
```
public java.lang.String[] getGroupOrder()
```
    Returns the group Order
    
    Returns:
    
    the groupOrder
  - setGroupOrder
```
public void setGroupOrder(java.lang.String[] groupOrder)
```
    The groupOrder to set
    
    Parameters:
    
    groupOrder -
  - setRefreshIdColumnIndices
```
public void setRefreshIdColumnIndices(int[] refreshIdColumnIndices)
```
    Set the refreshIdColumnIndices
    
    Parameters:
    
    refreshIdColumnIndices -
  - getRefreshIdColumnIndices
```
public int[] getRefreshIdColumnIndices()
```
    Returns the refreshIdColumnIndices
    
    Returns:
    
    refreshIdColumnIndices
  - getAutoRefreshSeconds
```
public int getAutoRefreshSeconds()
```
    Returns the autoRefreshInSeconds
    
    Returns:
    
    the autoRefreshSeconds
  - setAutoRefreshSeconds
```
public void setAutoRefreshSeconds(int autoRefreshSeconds)
```
    The autoRefreshSeconds to set
    
    Parameters:
    
    autoRefreshSeconds -
  - setFolderColumnIndex
```
public void setFolderColumnIndex(int folderColumnIndex)
```
    Set the folderColumnIndex
    
    Parameters:
    
    folderColumnIndex -
  - getFolderColumnIndex
```
public int getFolderColumnIndex()
```
    Returns the folderColumnIndex
    
    Returns:
    
    - the folderColumnIndex
  - getTileView
```
public TileView getTileView()
```
    Returns the TileView
    
    Returns:
    
    - the tileView
  - setTileView
```
public void setTileView(TileView tileView)
```
    Set the fileView
    
    Parameters:
    
    tileView - - the tileView to set
  - getViews
```
public int[] getViews()
```
    Returns the views
    
    Returns:
    
    - the views
  - setViews
```
public void setViews(int[] views)
```
    Set the views
    
    Parameters:
    
    views -
  - setTabularOnlyView
```
public void setTabularOnlyView()
```
    Set tabularViewOnly flag
  - setTileOnlyView
```
public void setTileOnlyView()
```
    Set the tileViewOnly flag
  - setTileAndTableView
```
public void setTileAndTableView()
```
    Set tileAndTableView flag
  - setTableAndTileView
```
public void setTableAndTileView()
```
    Set tableAndTileView flag
  - isAutoSortFolders
```
public boolean isAutoSortFolders()
```
    Retuns the autoSortFolders
    
    Returns:
    
    the autoSortFolders
  - setAutoSortFolders
```
public void setAutoSortFolders(boolean autoSortFolders)
```
    Indicates uiTreeNodeDefinitions folders shall be sorted by default
    
    Parameters:
    
    autoSortFolders -
  - getTotalRowCount
```
public int getTotalRowCount()
```
    Returns the totalRowCount
    
    Returns:
  - setTotalRowCount
```
public void setTotalRowCount(int totalRowCount)
```
    Set the totalRowcount
    
    Parameters:
    
    totalRowCount -
  - getMessageOnNoData
```
public java.lang.String getMessageOnNoData()
```
    Returns the messageOnNoData
    
    Returns:
    
    the messageOnNoData
  - setMessageOnNoData
```
public void setMessageOnNoData(java.lang.String messageOnNoData)
```
    Parameters:
    
    messageOnNoData - the message to be displayed to user when there is no data (rows.length = 0) if null (default), no message will be displayed

Class TabularReport

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VIEW_TABULAR

VIEW_TILE

VIEW__OPTIONS_TABULAR_ONLY

VIEW__OPTIONS_TILE_ONLY

VIEW__OPTIONS_TABULAR_AND_TILE

VIEW__OPTIONS_TILE_AND_TABULAR

Constructor Detail

TabularReport

Method Detail

getAppliedToFolderFlagIndex

setAppliedToFolderFlagIndex

getUiTreeNodeDefinitions

setUiTreeNodeDefinitions

getReportName

setReportName

getContext

setContext

getGeneratedTime

setGeneratedTime

getColumnDefinitions

setColumnDefinitions

getRows

setRows

getCustomSpec

setCustomSpec

getGroupOrder

setGroupOrder

setRefreshIdColumnIndices

getRefreshIdColumnIndices

getAutoRefreshSeconds

setAutoRefreshSeconds

setFolderColumnIndex

getFolderColumnIndex

getTileView

setTileView

getViews

setViews

setTabularOnlyView

setTileOnlyView

setTileAndTableView

setTableAndTileView

isAutoSortFolders

setAutoSortFolders

getTotalRowCount

setTotalRowCount

getMessageOnNoData

setMessageOnNoData