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

All Known Implementing Classes:

DateFieldFormat

public interface IDateFieldFormat

This interface is used to specify the format of the date field or the date part of the DateTimeField in the report object. You can specify properties such as the calendar type, the date, month, and year format, and the order in which the date elements appear.

This object describes how the DateFormat property shown by a FieldObject object should be formatted if the FieldObject object is being used to display dates. To access this object, use the getDateFormat method. If the field is not being used to represent a DateFormat property, and you modify this object, your changes will be ignored and discarded.

Method Summary

DateCalendarType	getCalendarType() Returns the calendar type for the date field.
DateFieldFormatConditionFormulas	getConditionFormulas() Returns the condition formulas used to override the date field's format settings.
java.lang.String	getDateFirstSeparator() Returns the first separator which separates the date elements.
DateOrder	getDateOrder() Returns the order in which the date elements will appear.
java.lang.String	getDatePrefixSeparator() Returns the prefix for the date.
java.lang.String	getDateSecondSeparator() Returns the second separator which separates the date elements.
java.lang.String	getDateSuffixSeparator() Returns the suffix for the date.
DayFormat	getDayFormat() Returns the format for displaying the day in the date.
DayOfWeekPosition	getDayOfWeekPosition() Returns where the name of the day appears.
java.lang.String	getDayOfWeekSeparator() Returns the separator which is inserted between the name of the day and the date.
DayOfWeekType	getDayOfWeekType() Returns the format for displaying the name of the day.
DateEraType	getEraType() Returns the format for displaying the era or period in the date.
MonthFormat	getMonthFormat() Returns the format for displaying the month in the date.
DateSystemDefaultType	getSystemDefaultType() Returns whether or not to use the default system date format.
YearFormat	getYearFormat() Returns the format for displaying the year in the date.
void	setCalendarType(DateCalendarType calendarType) Sets the calendar type for the date field.
void	setConditionFormulas(DateFieldFormatConditionFormulas conditionFormulas) Sets the condition formulas used to override the date field's format settings.
void	setDateFirstSeparator(java.lang.String dateFirstSeparator) Sets the first separator which separates the date elements.
void	setDateOrder(DateOrder dateOrder) Sets the order in which the date elements will appear.
void	setDatePrefixSeparator(java.lang.String datePrefixSeparator) Sets the prefix for the date.
void	setDateSecondSeparator(java.lang.String dateSecondSeparator) Sets the second separator that separates the date elements.
void	setDateSuffixSeparator(java.lang.String dateSuffixSeparator) Sets the suffix for the date.
void	setDayFormat(DayFormat dayFormat) Sets the format for displaying the day in the date.
void	setDayOfWeekPosition(DayOfWeekPosition dayOfWeekPosition) Sets where the name of the day appears.
void	setDayOfWeekSeparator(java.lang.String dayOfWeekSeparator) Sets the separator that is inserted between the name of the day and the date.
void	setDayOfWeekType(DayOfWeekType dayOfWeekType) Sets the format for displaying the name of the day.
void	setEraType(DateEraType eraType) Sets the format for displaying the era or period in the date.
void	setMonthFormat(MonthFormat monthFormat) Sets the format for displaying the month in the date.
void	setSystemDefaultType(DateSystemDefaultType systemDefaultType) Sets whether or not to use the default system date format.
void	setYearFormat(YearFormat yearFormat) Sets the format for displaying the year in the date.

Method Detail

getCalendarType

DateCalendarType getCalendarType()

Returns the calendar type for the date field.

Returns:

A DateCalendarType object that specifies the calendar type for the date field.

getConditionFormulas

DateFieldFormatConditionFormulas getConditionFormulas()

Returns the condition formulas used to override the date field's format settings.

Returns:

A DateFieldFormatConditionFormulas object containing the condition formulas used to override the date field's format settings.

getDateFirstSeparator

java.lang.String getDateFirstSeparator()

Returns the first separator which separates the date elements.

Returns:

A String that specifies the first separator which separates the date elements.

getDateOrder

DateOrder getDateOrder()

Returns the order in which the date elements will appear.

Returns:

A DateOrder object that specifies the order in which the date elements will appear.

getDatePrefixSeparator

java.lang.String getDatePrefixSeparator()

Returns the prefix for the date.

Returns:

A String that specifies the prefix for the date.

getDateSecondSeparator

java.lang.String getDateSecondSeparator()

Returns the second separator which separates the date elements.

Returns:

A String that specifies the second separator which separates the date elements.

getDateSuffixSeparator

java.lang.String getDateSuffixSeparator()

Returns the suffix for the date.

Returns:

A String that specifies the suffix for the date.

getDayFormat

DayFormat getDayFormat()

Returns the format for displaying the day in the date.

Returns:

A DayFormat object that specifies the format for displaying the day in the date.

getDayOfWeekPosition

DayOfWeekPosition getDayOfWeekPosition()

Returns where the name of the day appears.

Returns:

A DayOfWeekPosition object that specifies where the name of the day appears.

getDayOfWeekSeparator

java.lang.String getDayOfWeekSeparator()

Returns the separator which is inserted between the name of the day and the date.

Returns:

A String that specifies the separator which is inserted between the name of the day and the date.

getDayOfWeekType

DayOfWeekType getDayOfWeekType()

Returns the format for displaying the name of the day.

Returns:

A DayOfWeekType object that specifies the format for displaying the name of the day.

getEraType

DateEraType getEraType()

Returns the format for displaying the era or period in the date.

Returns:

A DateEraType object that specifies the format for displaying the era or period in the date.

getMonthFormat

MonthFormat getMonthFormat()

Returns the format for displaying the month in the date.

Returns:

A MonthFormat object that specifies the format for displaying the month in the date.

getSystemDefaultType

DateSystemDefaultType getSystemDefaultType()

Returns whether or not to use the default system date format.

Returns:

A DateSystemDefaultType object that specifies whether or not to use the default system date format.

getYearFormat

YearFormat getYearFormat()

Returns the format for displaying the year in the date.

Returns:

A YearFormat object that specifies the format for displaying the year in the date.

setCalendarType

void setCalendarType(DateCalendarType calendarType)

Sets the calendar type for the date field.

Parameters:

calendarType - A DateCalendarType object that specifies the calendar type for the date field.

setConditionFormulas

void setConditionFormulas(DateFieldFormatConditionFormulas conditionFormulas)

Sets the condition formulas used to override the date field's format settings.

Parameters:

conditionFormulas - A DateFieldFormatConditionFormulas object containing the condition formulas used to override the date field's format settings.

setDateFirstSeparator

void setDateFirstSeparator(java.lang.String dateFirstSeparator)

Sets the first separator which separates the date elements.

Parameters:

dateFirstSeparator - A String that specifies the first separator which separates the date elements.

setDateOrder

void setDateOrder(DateOrder dateOrder)

Sets the order in which the date elements will appear.

Parameters:

dateOrder - A DateOrder object that specifies the order in which the date elements will appear.

setDatePrefixSeparator

void setDatePrefixSeparator(java.lang.String datePrefixSeparator)

Sets the prefix for the date.

Parameters:

datePrefixSeparator - A String that specifies the prefix for the date.

setDateSecondSeparator

void setDateSecondSeparator(java.lang.String dateSecondSeparator)

Sets the second separator that separates the date elements.

Parameters:

dateSecondSeparator - A String that specifies the second separator that separates the date elements.

setDateSuffixSeparator

void setDateSuffixSeparator(java.lang.String dateSuffixSeparator)

Sets the suffix for the date.

Parameters:

dateSuffixSeparator - A String that specifies the suffix for the date.

setDayFormat

void setDayFormat(DayFormat dayFormat)

Sets the format for displaying the day in the date.

Parameters:

dayFormat - A DayFormat object that specifies the format for displaying the day in the date.

setDayOfWeekPosition

void setDayOfWeekPosition(DayOfWeekPosition dayOfWeekPosition)

Sets where the name of the day appears.

Parameters:

dayOfWeekPosition - A DayOfWeekPosition object that specifies where the name of the day appears.

setDayOfWeekSeparator

void setDayOfWeekSeparator(java.lang.String dayOfWeekSeparator)

Sets the separator that is inserted between the name of the day and the date.

Parameters:

dayOfWeekSeparator - A String that specifies the separator that is inserted between the name of the day and the date.

setDayOfWeekType

void setDayOfWeekType(DayOfWeekType dayOfWeekType)

Sets the format for displaying the name of the day.

Parameters:

dayOfWeekType - A DayOfWeekType object that specifies the format for displaying the name of the day.

setEraType

void setEraType(DateEraType eraType)

Sets the format for displaying the era or period in the date.

Parameters:

eraType - A DateEraType object that specifies the format for displaying the era or period in the date.

setMonthFormat

void setMonthFormat(MonthFormat monthFormat)

Sets the format for displaying the month in the date.

Parameters:

monthFormat - A MonthFormat object that specifies the format for displaying the month in the date.

setSystemDefaultType

void setSystemDefaultType(DateSystemDefaultType systemDefaultType)

Sets whether or not to use the default system date format.

Parameters:

systemDefaultType - A DateSystemDefaultType object that specifies whether or not to use the default system date format.

setYearFormat

void setYearFormat(YearFormat yearFormat)

Sets the format for displaying the year in the date.

Parameters:

yearFormat - A YearFormat object that specifies the format for displaying the year in the date.