org.eclipse.birt.data.engine.api.timefunction
Interface ITimeFunction

All Known Implementing Classes:
TimeFunction

public interface ITimeFunction


Method Summary
 ITimePeriod getBaseTimePeriod()
          Get the type of time function.
 IReferenceDate getReferenceDate()
          Get the reference date of a time function.
 ITimePeriod getRelativeTimePeriod()
          Get the relative time period of a time function.
 java.lang.String getTimeDimension()
          Get the time dimension based on which the time function will be calculated against.
 void setBaseTimePeriod(ITimePeriod timePeriod)
          Set the type of time function.
 void setReferenceDate(IReferenceDate referenceDate)
          Set the reference date of a time function.
 void setRelativeTimePeriod(ITimePeriod relativeTimePeriod)
          Set the relative time period of a time function.
 void setTimeDimension(java.lang.String timeDimension)
          Set the reference date of a time function.
 

Method Detail

setBaseTimePeriod

void setBaseTimePeriod(ITimePeriod timePeriod)
                       throws org.eclipse.birt.data.engine.core.DataException
Set the type of time function.

Throws:
org.eclipse.birt.data.engine.core.DataException

getBaseTimePeriod

ITimePeriod getBaseTimePeriod()
                              throws org.eclipse.birt.data.engine.core.DataException
Get the type of time function.

Throws:
org.eclipse.birt.data.engine.core.DataException

setTimeDimension

void setTimeDimension(java.lang.String timeDimension)
                      throws org.eclipse.birt.data.engine.core.DataException
Set the reference date of a time function.

Throws:
org.eclipse.birt.data.engine.core.DataException

getTimeDimension

java.lang.String getTimeDimension()
                                  throws org.eclipse.birt.data.engine.core.DataException
Get the time dimension based on which the time function will be calculated against.

Returns:
Throws:
org.eclipse.birt.data.engine.core.DataException

setReferenceDate

void setReferenceDate(IReferenceDate referenceDate)
                      throws org.eclipse.birt.data.engine.core.DataException
Set the reference date of a time function.

Parameters:
referenceDate -
Throws:
org.eclipse.birt.data.engine.core.DataException

getReferenceDate

IReferenceDate getReferenceDate()
                                throws org.eclipse.birt.data.engine.core.DataException
Get the reference date of a time function.

Returns:
Throws:
org.eclipse.birt.data.engine.core.DataException

setRelativeTimePeriod

void setRelativeTimePeriod(ITimePeriod relativeTimePeriod)
                           throws org.eclipse.birt.data.engine.core.DataException
Set the relative time period of a time function.

Parameters:
relativeTimePeriod -
Throws:
org.eclipse.birt.data.engine.core.DataException

getRelativeTimePeriod

ITimePeriod getRelativeTimePeriod()
                                  throws org.eclipse.birt.data.engine.core.DataException
Get the relative time period of a time function.

Returns:
Throws:
org.eclipse.birt.data.engine.core.DataException


Copyright © 2008 Actuate Corp. All rights reserved.