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

All Superinterfaces:
IClone
All Known Implementing Classes:
TimeFieldFormat

public interface ITimeFieldFormat
extends IClone

This interface is used to get and set how the time format shown by a FieldObject should be formatted if the FieldObject is being used to display time. If the field is not being used to represent a TimeFormat property, and you modify this object, your changes will be ignored and discarded.


Method Summary
 AMPMFormat getAMPMFormat()
          Returns the position for AM or PM.
 java.lang.String getAMString()
          Returns the String used to identify the time that is between midnight and noon.
 TimeFieldFormatConditionFormulas getConditionFormulas()
          Returns the condition formulas for the time field format.
 HourFormat getHourFormat()
          Returns the format for displaying the hour.
 java.lang.String getHourMinuteSeparator()
          Returns the separator used to separate the hours and minutes.
 MinuteFormat getMinuteFormat()
          Returns the format for displaying the minutes.
 java.lang.String getMinuteSecondSeparator()
          Returns the separator used to separate the minutes and seconds.
 java.lang.String getPMString()
          Returns the String used to identify the time that is between noon and midnight.
 SecondFormat getSecondFormat()
          Returns the format for displaying the seconds.
 TimeBase getTimeBase()
          Returns the time base.
 void setAMPMFormat(AMPMFormat aMPMFormat)
          Sets the position for AM or PM.
 void setAMString(java.lang.String aMString)
          Sets the String used to identify the time that is between midnight and noon.
 void setConditionFormulas(TimeFieldFormatConditionFormulas conditionFormulas)
          Sets the condition formulas for the time field format.
 void setHourFormat(HourFormat hourFormat)
          Sets the format for displaying the hour.
 void setHourMinuteSeparator(java.lang.String hourMinuteSeparator)
          Sets the separator used to separate the hours and minutes.
 void setMinuteFormat(MinuteFormat minuteFormat)
          Sets the format for displaying the minutes.
 void setMinuteSecondSeparator(java.lang.String minuteSecondSeparator)
          Sets the separator used to separate the minutes and seconds.
 void setPMString(java.lang.String pMString)
          Sets the String used to identify the time that is between noon and midnight.
 void setSecondFormat(SecondFormat secondFormat)
          Sets the format for displaying the seconds.
 void setTimeBase(TimeBase timeBase)
          Sets the time base.
 

Method Detail

getAMPMFormat

AMPMFormat getAMPMFormat()

Returns the position for AM or PM.

Returns:
The AM PM format as an AMPMFormat.

getAMString

java.lang.String getAMString()

Returns the String used to identify the time that is between midnight and noon.

Returns:
The AM String.

getConditionFormulas

TimeFieldFormatConditionFormulas getConditionFormulas()

Returns the condition formulas for the time field format.

Returns:
The condition formulas as TimeFieldFormatConditionFormulas.

getHourFormat

HourFormat getHourFormat()

Returns the format for displaying the hour.

Returns:
The hour format as an HourFormat.

getHourMinuteSeparator

java.lang.String getHourMinuteSeparator()

Returns the separator used to separate the hours and minutes.

Returns:
The separator as a String.

getMinuteFormat

MinuteFormat getMinuteFormat()

Returns the format for displaying the minutes.

Returns:
The minute format as a MinuteFormat.

getMinuteSecondSeparator

java.lang.String getMinuteSecondSeparator()

Returns the separator used to separate the minutes and seconds.

Returns:
The separator as a String.

getPMString

java.lang.String getPMString()

Returns the String used to identify the time that is between noon and midnight.

Returns:
The PM String.

getSecondFormat

SecondFormat getSecondFormat()

Returns the format for displaying the seconds.

Returns:
The minute format as a SecondFormat.

getTimeBase

TimeBase getTimeBase()

Returns the time base. The time base specifies that the time is in either a 12-hour or 24-hour format.

Returns:
The time base as a TimeBase.

setAMPMFormat

void setAMPMFormat(AMPMFormat aMPMFormat)

Sets the position for AM or PM.

Parameters:
aMPMFormat - The AM PM format as an AMPMFormat.

setAMString

void setAMString(java.lang.String aMString)

Sets the String used to identify the time that is between midnight and noon.

Parameters:
aMString - The AM String.

setConditionFormulas

void setConditionFormulas(TimeFieldFormatConditionFormulas conditionFormulas)

Sets the condition formulas for the time field format.

Parameters:
conditionFormulas - The condition formulas as TimeFieldFormatConditionFormulas.

setHourFormat

void setHourFormat(HourFormat hourFormat)

Sets the format for displaying the hour.

Parameters:
hourFormat - The hour format as an HourFormat.

setHourMinuteSeparator

void setHourMinuteSeparator(java.lang.String hourMinuteSeparator)

Sets the separator used to separate the hours and minutes.

Parameters:
hourMinuteSeparator - The separator as a String.

setMinuteFormat

void setMinuteFormat(MinuteFormat minuteFormat)

Sets the format for displaying the minutes.

Parameters:
minuteFormat - The minute format as a MinuteFormat.

setMinuteSecondSeparator

void setMinuteSecondSeparator(java.lang.String minuteSecondSeparator)

Sets the separator used to separate the minutes and seconds.

Parameters:
minuteSecondSeparator - The separator as a String.

setPMString

void setPMString(java.lang.String pMString)

Sets the String used to identify the time that is between noon and midnight.

Parameters:
pMString - The PM String.

setSecondFormat

void setSecondFormat(SecondFormat secondFormat)

Sets the format for displaying the seconds.

Parameters:
secondFormat - The minute format as a SecondFormat.

setTimeBase

void setTimeBase(TimeBase timeBase)

Sets the time base. The time base specifies that the time is in either a 12-hour or 24-hour format.

Parameters:
timeBase - The time base as a TimeBase.