Package com.microstrategy.web.objects
Interface WebTime
-
- All Known Subinterfaces:
WebTimeNode
public interface WebTime
The WebTime interface represents a static or dynamic time. The properties on this interface can be used to get and set the properties of the static/dynamic time.- Since:
- MicroStrategy Web 8.0.2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getDynamicDay()
Returns the day setting for the dynamic date.int
getDynamicDayOffset()
Gets the dynamic day offset.int
getDynamicDayOfWeek()
Returns the day of week setting for the dynamic date.int
getDynamicHour()
Returns the hour setting for a dynamic date time.int
getDynamicMinute()
Returns the minute setting for a dynamic date time.int
getDynamicMonth()
Returns the month setting for the dynamic date.int
getDynamicMonthOffset()
Gets the dynamic month offset.int
getDynamicSecond()
Returns the second setting for a dynamic date time.int
getDynamicTimeType()
Returns the dynamic time type, fromEnumDSSXMLDynamicTime
.int
getDynamicWeek()
Returns the week setting for the dynamic date.int
getDynamicYear()
Returns the year setting for the dynamic date.java.lang.String
getText()
Returns the text representation of the date.java.lang.String
getTime()
Returns the resolved form of the time.boolean
isDynamicDate()
Returns whether the WebTime object refers to a dynamic date.void
setDynamicDay(int day)
Sets the day setting for the dynamic date.void
setDynamicDayOffset(int offset)
Sets the dynamic day offset.void
setDynamicDayOfWeek(int dow)
Sets the day of week setting for the dynamic date.void
setDynamicHour(int hour)
Sets the hour setting for the dynamic date time.void
setDynamicMinute(int minute)
Sets the minute setting for the dynamic date time.void
setDynamicMonth(int month)
Sets the month setting for the dynamic date.void
setDynamicMonthOffset(int offset)
Sets the dynamic month offset.void
setDynamicSecond(int second)
Sets the second setting for the dynamic date time.void
setDynamicTimeType(int type)
Sets the dynamic time type.void
setDynamicWeek(int week)
Sets the week setting for the dynamic date.void
setDynamicYear(int year)
Sets the year setting for the dynamic date.void
setTime(java.lang.String time)
Sets a static time as the new time.
-
-
-
Method Detail
-
getTime
java.lang.String getTime()
Returns the resolved form of the time. In the case of a static date, this will be the date text; for a dynamic date, this will be the resolved date.- Returns:
- The resolved form of the time.
-
setTime
void setTime(java.lang.String time)
Sets a static time as the new time. If the time was dynamic, calling this method will convert it into a static time.- Parameters:
time
- The new time, in String format.
-
isDynamicDate
boolean isDynamicDate()
Returns whether the WebTime object refers to a dynamic date.- Returns:
- True if the date is dynamic, false otherwise.
-
getDynamicTimeType
int getDynamicTimeType()
Returns the dynamic time type, fromEnumDSSXMLDynamicTime
. This tells the general type of qualification.- Returns:
- The current dynamic time type, from
EnumDSSXMLDynamicTime
.
-
setDynamicTimeType
void setDynamicTimeType(int type)
Sets the dynamic time type. This tells the general type of qualification. The value must be fromEnumDSSXMLDynamicTime
.- Parameters:
type
- The new value for the dynamic time type, fromEnumDSSXMLDynamicTime
.
-
getDynamicDayOffset
int getDynamicDayOffset()
Gets the dynamic day offset.- Returns:
- The current offset.
-
setDynamicDayOffset
void setDynamicDayOffset(int offset)
Sets the dynamic day offset.- Parameters:
offset
- The new value for the offset.
-
getDynamicMonthOffset
int getDynamicMonthOffset()
Gets the dynamic month offset.- Returns:
- The current offset.
-
setDynamicMonthOffset
void setDynamicMonthOffset(int offset)
Sets the dynamic month offset.- Parameters:
offset
- The new value for the offset.
-
getDynamicYear
int getDynamicYear()
Returns the year setting for the dynamic date.- Returns:
- The current year setting of the dynamic date.
-
setDynamicYear
void setDynamicYear(int year)
Sets the year setting for the dynamic date.- Parameters:
year
- The year setting for the dynamic date.
-
getDynamicMonth
int getDynamicMonth()
Returns the month setting for the dynamic date.- Returns:
- The current month setting of the dynamic date, from
EnumDSSXMLMonth
.
-
setDynamicMonth
void setDynamicMonth(int month)
Sets the month setting for the dynamic date. This should be a value fromEnumDSSXMLMonth
.- Parameters:
month
- The month setting for the dynamic date.
-
getDynamicWeek
int getDynamicWeek()
Returns the week setting for the dynamic date.- Returns:
- The current week setting of the dynamic date.
-
setDynamicWeek
void setDynamicWeek(int week)
Sets the week setting for the dynamic date.- Parameters:
week
- The week setting for the dynamic date.
-
getDynamicDayOfWeek
int getDynamicDayOfWeek()
Returns the day of week setting for the dynamic date. This should be a value fromEnumDSSXMLDayOfWeek
.- Returns:
- The current week setting of the dynamic date.
-
setDynamicDayOfWeek
void setDynamicDayOfWeek(int dow)
Sets the day of week setting for the dynamic date. This should be a value fromEnumDSSXMLDayOfWeek
.- Parameters:
dow
- The new setting for day of week, fromEnumDSSXMLDayOfWeek
.
-
getDynamicDay
int getDynamicDay()
Returns the day setting for the dynamic date.- Returns:
- The current day setting of the dynamic date.
-
setDynamicDay
void setDynamicDay(int day)
Sets the day setting for the dynamic date.- Parameters:
day
- The day setting for the dynamic date.
-
getDynamicHour
int getDynamicHour()
Returns the hour setting for a dynamic date time.- Returns:
- The hour offset from the current hour.
-
setDynamicHour
void setDynamicHour(int hour)
Sets the hour setting for the dynamic date time.- Parameters:
hour
- The hour setting for the dynamic date time.
-
getDynamicMinute
int getDynamicMinute()
Returns the minute setting for a dynamic date time.- Returns:
- The minute offset from the current minute.
-
setDynamicMinute
void setDynamicMinute(int minute)
Sets the minute setting for the dynamic date time.- Parameters:
minute
- The minute setting for the dynamic date time.
-
getDynamicSecond
int getDynamicSecond()
Returns the second setting for a dynamic date time.- Returns:
- The second offset from the current minute.
-
setDynamicSecond
void setDynamicSecond(int second)
Sets the second setting for the dynamic date time.- Parameters:
second
- The second setting for the dynamic date time.
-
getText
java.lang.String getText()
Returns the text representation of the date. For a static date, this will be the same as getTime. For a dynamic date, this will be a text string that describes the dynamic date. That text string will be the same descriptive string that desktop uses.- Returns:
- The text representation of the date.
-
-