com.crystaldecisions.sdk.occa.report.definition
Interface IFieldFormat

All Superinterfaces:
IClone
All Known Implementing Classes:
FieldFormat

public interface IFieldFormat
extends IClone

This interface enables you to specify the format of the field, including the date and time format, the numeric format, the string format, and so on.


Method Summary
 IBooleanFieldFormat getBooleanFormat()
           Returns the boolean format for the field if the field is a boolean field.
 ICommonFieldFormat getCommonFormat()
           Returns the common format for the field.
 IDateFieldFormat getDateFormat()
           Returns the date format for the field if the field is a date or DateTime field.
 IDateTimeFieldFormat getDateTimeFormat()
           Returns the DateTime format for the field if the field is a DateTime field.
 INumericFieldFormat getNumericFormat()
           Returns the numeric format for the field if the field is a numeric field.
 IStringFieldFormat getStringFormat()
           Returns the string format for the field if the field is a String field.
 ITimeFieldFormat getTimeFormat()
           Returns the time format for the field if the field is a time or DateTime field.
 void setBooleanFormat(IBooleanFieldFormat booleanFormat)
           Sets the boolean format for the field if the field is a boolean field.
 void setCommonFormat(ICommonFieldFormat commonFormat)
           Sets the common format for the field.
 void setDateFormat(IDateFieldFormat dateFormat)
           Sets the date format for the field if the field is a date or DateTime field.
 void setDateTimeFormat(IDateTimeFieldFormat dateTimeFormat)
           Sets the DateTime format for the field if the field is a DateTime field.
 void setNumericFormat(INumericFieldFormat numericFormat)
           Sets the numeric format for the field if the field is a numeric field.
 void setStringFormat(IStringFieldFormat stringFormat)
           Sets the string format for the field if the field is a String field.
 void setTimeFormat(ITimeFieldFormat timeFormat)
           Sets the time format for the field if the field is a time or DateTime field.
 

Method Detail

getBooleanFormat

IBooleanFieldFormat getBooleanFormat()

Returns the boolean format for the field if the field is a boolean field.

Returns:
An IBooleanFieldFormat object that specifies the boolean format for the field.

getCommonFormat

ICommonFieldFormat getCommonFormat()

Returns the common format for the field. (Applies to any field value type.)

Returns:
An ICommonFieldFormat object that specifies the common format for the field.

getDateFormat

IDateFieldFormat getDateFormat()

Returns the date format for the field if the field is a date or DateTime field.

Returns:
An IDateFieldFormat object that specifies the date format for the field.

getDateTimeFormat

IDateTimeFieldFormat getDateTimeFormat()

Returns the DateTime format for the field if the field is a DateTime field.

Returns:
An IDateTimeFieldFormat object that specifies the DateTime format for the field.

getNumericFormat

INumericFieldFormat getNumericFormat()

Returns the numeric format for the field if the field is a numeric field.

Returns:
An INumericFieldFormat object that specifies the numeric format for the field.

getStringFormat

IStringFieldFormat getStringFormat()

Returns the string format for the field if the field is a String field.

Returns:
An IStringFieldFormat object that specifies the string format for the field.

getTimeFormat

ITimeFieldFormat getTimeFormat()

Returns the time format for the field if the field is a time or DateTime field.

Returns:
An ITimeFieldFormat object that specifies the time format for the field.

setBooleanFormat

void setBooleanFormat(IBooleanFieldFormat booleanFormat)

Sets the boolean format for the field if the field is a boolean field.

Parameters:
booleanFormat - An IBooleanFieldFormat object that specifies the boolean format for the field.

setCommonFormat

void setCommonFormat(ICommonFieldFormat commonFormat)

Sets the common format for the field. (Applies to any field value type.)

Parameters:
commonFormat - An ICommonFieldFormat object that specifies the common format for the field.

setDateFormat

void setDateFormat(IDateFieldFormat dateFormat)

Sets the date format for the field if the field is a date or DateTime field.

Parameters:
dateFormat - An IDateFieldFormat object that specifies the date format for the field.

setDateTimeFormat

void setDateTimeFormat(IDateTimeFieldFormat dateTimeFormat)

Sets the DateTime format for the field if the field is a DateTime field.

Parameters:
dateTimeFormat - An IDateTimeFieldFormat object that specifies the DateTime format for the field.

setNumericFormat

void setNumericFormat(INumericFieldFormat numericFormat)

Sets the numeric format for the field if the field is a numeric field.

Parameters:
numericFormat - An INumericFieldFormat object that specifies the numeric format for the field.

setStringFormat

void setStringFormat(IStringFieldFormat stringFormat)

Sets the string format for the field if the field is a String field.

Parameters:
stringFormat - An IStringFieldFormat object that specifies the string format for the field.

setTimeFormat

void setTimeFormat(ITimeFieldFormat timeFormat)

Sets the time format for the field if the field is a time or DateTime field.

Parameters:
timeFormat - An ITimeFieldFormat object that specifies the time format for the field.