Skip navigation links

ilog.rules.teamserver.model.reporting
Class IlrReportContext

java.lang.Object
  ilog.rules.teamserver.model.reporting.IlrReportContext

public class IlrReportContext
extends Object

This class represents the context in which a report is processed.

Constructor Summary

IlrReportContext(IlrSession session)
Creates a context with a given session.

Method Summary

void	addClientData(String property, Object value) Adds the user object bound to a given property.
void	addProperty(String property, Object value) Adds a given property to the context.
Object	getClientData(String property) Returns the user object bound to a given property.
List<String>	getPropertyNames() Returns a list of the properties bound to this context.
Object	getPropertyValue(String property) Returns the object bound to a given property.
IlrReportFilter	getReportFilter() Returns an instance of IlrReportFilter to filter the elements used in the report.
IlrReportSorter	getReportSorter() Returns an instance of IlrReportSorter to sort the elements used in the report.
IlrSession	getSession() Returns the session bound to this context.
void	removeClientData(String property) Removes the user object bound to a given property.
void	removeProperty(String property) Removes a given property from the context.
void	setReportFilter(IlrReportFilter reportFilter) Sets an instance of IlrReportFilter to filter the elements used in the report.
void	setReportSorter(IlrReportSorter reportSorter) Sets an instance of IlrReportSorter to sort the elements used in the report.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlrReportContext

public IlrReportContext(IlrSession session)

Creates a context with a given session.

Parameters:

session - The session.

Method Detail

getSession

public IlrSession getSession()

Returns the session bound to this context.

getReportFilter

public IlrReportFilter getReportFilter()

Returns an instance of IlrReportFilter to filter the elements used in the report.

setReportFilter

public void setReportFilter(IlrReportFilter reportFilter)

Sets an instance of IlrReportFilter to filter the elements used in the report.

Parameters:

reportFilter - An instance of IlrReportFilter.

getReportSorter

public IlrReportSorter getReportSorter()

Returns an instance of IlrReportSorter to sort the elements used in the report.

setReportSorter

public void setReportSorter(IlrReportSorter reportSorter)

Sets an instance of IlrReportSorter to sort the elements used in the report.

Parameters:

reportSorter - An instance of IlrReportSorter.

addProperty

public void addProperty(String property,
                        Object value)

Adds a given property to the context.

Parameters:

property - The name of the property.

value - The value of the property.

removeProperty

public void removeProperty(String property)

Removes a given property from the context.

Parameters:

property - The name of the property.

getPropertyValue

public Object getPropertyValue(String property)

Returns the object bound to a given property.

Parameters:

property - The property.

getPropertyNames

public List<String> getPropertyNames()

Returns a list of the properties bound to this context.

addClientData

public void addClientData(String property,
                          Object value)

Adds the user object bound to a given property.

Parameters:

property - The property.

value - The object.

removeClientData

public void removeClientData(String property)

Removes the user object bound to a given property.

Parameters:

property - The property.

getClientData

public Object getClientData(String property)

Returns the user object bound to a given property.

Parameters:

property - The property.