com.sap.sl.sdk.authoring.businesslayer

Interface ValueFormat

public interface ValueFormat

A representation of the model object 'Value Format'.

This object represents a format value used to set the custom format of a business object.

It is made of two parts:

• The string that defines the format. By default, it is an empty string.
• The color that is a value from the FormatColor enum. By default, it is AUTOMATIC, which means no color is defined. The color is not saved in the string.

The following features are supported:

• Format
• Color

Method Summary

Modifier and Type	Method and Description
FormatColor	getColor() Returns the value of the 'Color' attribute.
java.lang.String	getFormat() Returns the value of the 'Format' attribute.
void	setColor(FormatColor value) Sets the value of the 'Color' attribute.
void	setFormat(java.lang.String value) Sets the value of the 'Format' attribute.

Method Detail

getFormat

java.lang.String getFormat()

Returns the value of the 'Format' attribute. The default value is "".

This string represents the format of the business object values.

Returns:

the value of the 'Format' attribute.

See Also:

setFormat(String)

setFormat

void setFormat(java.lang.String value)

Sets the value of the 'Format' attribute.

This string represents the format of the business object values.

This string can be defined using any pattern provided by the BI Semantic Layer Java SDK, for example "MM-dd-yyyy". There is no incorrect format. The pattern identified is replaced with values. Other unrecognized patterns are considered as simple strings. The SDK does not throw any error in that case. Use single quotes to escape a pattern character. See the developer guide for the list of patterns.

Parameters:

value - the new value of the 'Format' attribute.

See Also:

getFormat()

getColor

FormatColor getColor()

Returns the value of the 'Color' attribute. The default value is "". The literals are from the enumeration FormatColor.

This object represents the color of the business object values.

Returns:

the value of the 'Color' attribute.

See Also:

FormatColor, setColor(FormatColor)

setColor

void setColor(FormatColor value)

Sets the value of the 'Color' attribute.

This object represents the color of the business object values.

Parameters:

value - the new value of the 'Color' attribute.

See Also:

FormatColor, getColor()