lumis.portal.report
Class ReportParameter

java.lang.Object
  lumis.portal.report.ReportParameter

@StableMinor(version="6.1",
             sinceVersion="4.2")
public class ReportParameter
extends java.lang.Object

A parameter entry of a Report.

Since:

4.2.0

Constructor Summary

ReportParameter()

Method Summary

void	delete() Deletes this parameter.
java.lang.String	getId() Returns the identifier of this parameter.
java.lang.String	getName() Returns the display name for this parameter.
Report	getReport() Returns the report this parameter belongs to.
java.lang.String	getValue() Returns the value for this parameter.
void	setName(java.lang.String name) Sets the display name for this parameter.
void	setValue(java.lang.String value) Sets the value for this parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportParameter

public ReportParameter()

Method Detail

getId

public java.lang.String getId()

Returns the identifier of this parameter.

Returns:

the identifier.

Since:

4.2.0

getName

public java.lang.String getName()

Returns the display name for this parameter.

Returns:

the display name.

Since:

4.2.0

setName

public void setName(java.lang.String name)

Sets the display name for this parameter.

Parameters:

name - the display name.

Since:

4.2.0

getValue

public java.lang.String getValue()

Returns the value for this parameter.

Returns:

the value for this parameter.

Since:

4.2.0

setValue

public void setValue(java.lang.String value)

Sets the value for this parameter.

Parameters:

value - the value.

Since:

4.2.0

getReport

public Report getReport()

Returns the report this parameter belongs to.

Returns:

the report.

Since:

4.2.0

delete

public void delete()
            throws PortalException

Deletes this parameter. This method also removes the parameter from Report.getParameters(), for further consistency.

Throws:

PortalException

Since:

4.2.0