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

All Superinterfaces:
IClone
All Known Implementing Classes:
DateTimeFieldFormat

public interface IDateTimeFieldFormat
extends IClone

This interface describes how a DateTime value shown by a FieldObject object should be formatted if the FieldObject object is being used to display dates and/or times. To access this object, use the following method:

 FieldFormat fieldFormat = fieldObject.getFieldFormat();
 IDateTimeFieldFormat dateTimeFormat = fieldFormat.getDateTimeFormat();
 
If the field is not being used to represent a DateTime value, and you modify this object, your changes will be ignored and discarded.


Method Summary
 DateTimeFieldFormatConditionFormulas getConditionFormulas()
           Returns the condition formulas used to override the date field's format settings.
 DateTimeOrder getDateTimeOrder()
           Returns the order in which the elements of DateTime field appear.
 java.lang.String getDateTimeSeparator()
           Returns the separator between the date and time.
 void setConditionFormulas(DateTimeFieldFormatConditionFormulas conditionFormulas)
           Sets the condition formulas used to override the date field's format settings.
 void setDateTimeOrder(DateTimeOrder dateTimeOrder)
           Sets the order in which the elements of DateTime field appear.
 void setDateTimeSeparator(java.lang.String dateTimeSeparator)
           Sets the separator between the date and time.
 

Method Detail

getConditionFormulas

DateTimeFieldFormatConditionFormulas getConditionFormulas()

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

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

getDateTimeOrder

DateTimeOrder getDateTimeOrder()

Returns the order in which the elements of DateTime field appear.

Returns:
A DateTimeOrder object that specifies the order in which the elements of DateTime field appear.

getDateTimeSeparator

java.lang.String getDateTimeSeparator()

Returns the separator between the date and time.

Returns:
A String containing the separator between the date and time.

setConditionFormulas

void setConditionFormulas(DateTimeFieldFormatConditionFormulas conditionFormulas)

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

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

setDateTimeOrder

void setDateTimeOrder(DateTimeOrder dateTimeOrder)

Sets the order in which the elements of DateTime field appear.

Parameters:
dateTimeOrder - A DateTimeOrder object that specifies the order in which the elements of DateTime field appear.

setDateTimeSeparator

void setDateTimeSeparator(java.lang.String dateTimeSeparator)

Sets the separator between the date and time.

Parameters:
dateTimeSeparator - A String containing the separator between the date and time.