lumis.portal.report
Class ReportTypeParameter

java.lang.Object
  lumis.portal.report.ReportTypeParameter

@StableMinor(version="6.2",
             sinceVersion="4.2")
public class ReportTypeParameter
extends Object

A parameter of a report type.

Since:

4.2.0

Constructor Summary

ReportTypeParameter()

Method Summary

void	delete() Deletes this parameter.
String	getId() Returns the identifier of this report type parameter.
String	getName() Returns the name of this report type parameter.
ReportType	getReportType() Returns the report type this parameter belongs to.
String	getType() Returns the type of this parameter.
String	getValue() Returns the value for this parameter.
void	setName(String name) Sets the name of this report type parameter.
void	setType(String type) Sets the type of this parameter.
void	setValue(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

ReportTypeParameter

public ReportTypeParameter()

Method Detail

getId

public String getId()

Returns the identifier of this report type parameter.

Returns:

the identifier.

Since:

4.2.0

getName

public String getName()

Returns the name of this report type parameter.

Returns:

the name.

Since:

4.2.0

setName

public void setName(String name)

Sets the name of this report type parameter.

Parameters:

name - the name.

Since:

4.2.0

getType

public String getType()

Returns the type of this parameter. The type is the full class name of the type this parameter's value is converted to before being provided for a report. If not specified, the parameter value is provided without any conversion.

Returns:

the type of this parameter, or null if it is not specified.

Since:

4.2.0

setType

public void setType(String type)

Sets the type of this parameter.

Parameters:

type - the type to set.

Since:

4.2.0

See Also:

getType()

getValue

public String getValue()

Returns the value for this parameter. If set, this value is always used for this parameter. Note that this value may be converted before provided to the report, according to getType().

Returns:

the value for this parameter, or null if it is not set.

Since:

4.2.0

setValue

public void setValue(String value)

Sets the value for this parameter.

Parameters:

value - the value to set.

Since:

4.2.0

See Also:

getValue()

getReportType

public ReportType getReportType()

Returns the report type this parameter belongs to.

Returns:

the report type.

Since:

4.2.0

delete

public void delete()
            throws PortalException

Deletes this parameter.

Throws:

PortalException

Since:

4.2.0