com.businessobjects.rebean.wi
Interface FormatNumber

All Known Subinterfaces:

DefaultDateTimeFormatNumber

public interface FormatNumber

Represents a way of displaying values in a report.

All format numbers are grouped in lists, as returned by ReportEngine.getDefaultFormatNumber(FormatNumberType). Any changes made to a standard format number will always create a custom format (after making changes, FormatNumber.getType() will always return FormatNumberType.CUSTOM). Modifying an existing custom format will only create a new custom format when it is already used in a report.

Method Summary

java.lang.String	getNegative() Returns the format used for negative values.
java.lang.String	getPositive() Returns the format used for positive values.
java.lang.String	getSample() Returns a String containing an example of a value using this object format.
FormatNumberType	getType() Returns the type of format number this object is part of.
java.lang.String	getUndefined() Returns the format used for undefined values.
java.lang.String	getZero() Returns the format used for zero values.
void	setNegative(java.lang.String value) Sets the format used for negative values.
void	setPositive(java.lang.String value) Sets the format used for positive values.
void	setUndefined(java.lang.String value) Sets the format used for undefined values.
void	setZero(java.lang.String value) Sets the format used for zero values.

Method Detail

getType

FormatNumberType getType()

Returns the type of format number this object is part of.

Returns:

the format number type

See Also:

ReportEngine.getDefaultFormatNumber(FormatNumberType)

getPositive

java.lang.String getPositive()

Returns the format used for positive values.

Returns:

the positive format

setPositive

void setPositive(java.lang.String value)

Sets the format used for positive values. After calling this method, getType() will always return FormatNumberType.CUSTOM and this object will be part of the custom list. No standard object format will be changed.

Parameters:

value - the new format

getNegative

java.lang.String getNegative()

Returns the format used for negative values.

Returns:

the negative format

setNegative

void setNegative(java.lang.String value)

Sets the format used for negative values. After calling this method, getType() will always return FormatNumberType.CUSTOM and this object will be part of the custom list. No standard object format will be changed.

Parameters:

value - the new format

getZero

java.lang.String getZero()

Returns the format used for zero values.

Returns:

the zero value format

setZero

void setZero(java.lang.String value)

Sets the format used for zero values. After calling this method, getType() will always return FormatNumberType.CUSTOM and this object will be part of the custom list. No standard object format will be changed.

Parameters:

value - the new format

getUndefined

java.lang.String getUndefined()

Returns the format used for undefined values.

Returns:

the undefined value format

setUndefined

void setUndefined(java.lang.String value)

Sets the format used for undefined values. After calling this method, getType() will always return FormatNumberType.CUSTOM and this object will be part of the custom list. No standard object format will be changed.

Parameters:

value - the new format

getSample

java.lang.String getSample()

Returns a String containing an example of a value using this object format.

Returns:

a sample value using this object format, or null when this is a custom object format