public interface

WebTime

com.microstrategy.web.objects.WebTime
Known Indirect Subclasses

Class Overview

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.

Summary

Public Methods
abstract int getDynamicDay()
Returns the day setting for the dynamic date.
abstract int getDynamicDayOfWeek()
Returns the day of week setting for the dynamic date.
abstract int getDynamicDayOffset()
Gets the dynamic day offset.
abstract int getDynamicHour()
Returns the hour setting for a dynamic date time.
abstract int getDynamicMinute()
Returns the minute setting for a dynamic date time.
abstract int getDynamicMonth()
Returns the month setting for the dynamic date.
abstract int getDynamicMonthOffset()
Gets the dynamic month offset.
abstract int getDynamicSecond()
Returns the second setting for a dynamic date time.
abstract int getDynamicTimeType()
Returns the dynamic time type, from EnumDSSXMLDynamicTime.
abstract int getDynamicWeek()
Returns the week setting for the dynamic date.
abstract int getDynamicYear()
Returns the year setting for the dynamic date.
abstract String getText()
Returns the text representation of the date.
abstract String getTime()
Returns the resolved form of the time.
abstract boolean isDynamicDate()
Returns whether the WebTime object refers to a dynamic date.
abstract void setDynamicDay(int day)
Sets the day setting for the dynamic date.
abstract void setDynamicDayOfWeek(int dow)
Sets the day of week setting for the dynamic date.
abstract void setDynamicDayOffset(int offset)
Sets the dynamic day offset.
abstract void setDynamicHour(int hour)
Sets the hour setting for the dynamic date time.
abstract void setDynamicMinute(int minute)
Sets the minute setting for the dynamic date time.
abstract void setDynamicMonth(int month)
Sets the month setting for the dynamic date.
abstract void setDynamicMonthOffset(int offset)
Sets the dynamic month offset.
abstract void setDynamicSecond(int second)
Sets the second setting for the dynamic date time.
abstract void setDynamicTimeType(int type)
Sets the dynamic time type.
abstract void setDynamicWeek(int week)
Sets the week setting for the dynamic date.
abstract void setDynamicYear(int year)
Sets the year setting for the dynamic date.
abstract void setTime(String time)
Sets a static time as the new time.

Public Methods

public abstract int getDynamicDay ()

Returns the day setting for the dynamic date.

Returns
  • The current day setting of the dynamic date.

public abstract int getDynamicDayOfWeek ()

Returns the day of week setting for the dynamic date. This should be a value from EnumDSSXMLDayOfWeek.

Returns
  • The current week setting of the dynamic date.

public abstract int getDynamicDayOffset ()

Gets the dynamic day offset.

Returns
  • The current offset.

public abstract int getDynamicHour ()

Returns the hour setting for a dynamic date time.

Returns
  • The hour offset from the current hour.

public abstract int getDynamicMinute ()

Returns the minute setting for a dynamic date time.

Returns
  • The minute offset from the current minute.

public abstract int getDynamicMonth ()

Returns the month setting for the dynamic date.

Returns

public abstract int getDynamicMonthOffset ()

Gets the dynamic month offset.

Returns
  • The current offset.

public abstract int getDynamicSecond ()

Returns the second setting for a dynamic date time.

Returns
  • The second offset from the current minute.

public abstract int getDynamicTimeType ()

Returns the dynamic time type, from EnumDSSXMLDynamicTime. This tells the general type of qualification.

Returns

public abstract int getDynamicWeek ()

Returns the week setting for the dynamic date.

Returns
  • The current week setting of the dynamic date.

public abstract int getDynamicYear ()

Returns the year setting for the dynamic date.

Returns
  • The current year setting of the dynamic date.

public abstract 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.

public abstract 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.

public abstract boolean isDynamicDate ()

Returns whether the WebTime object refers to a dynamic date.

Returns
  • True if the date is dynamic, false otherwise.

public abstract void setDynamicDay (int day)

Sets the day setting for the dynamic date.

Parameters
day The day setting for the dynamic date.

public abstract void setDynamicDayOfWeek (int dow)

Sets the day of week setting for the dynamic date. This should be a value from EnumDSSXMLDayOfWeek.

Parameters
dow The new setting for day of week, from EnumDSSXMLDayOfWeek.

public abstract void setDynamicDayOffset (int offset)

Sets the dynamic day offset.

Parameters
offset The new value for the offset.

public abstract void setDynamicHour (int hour)

Sets the hour setting for the dynamic date time.

Parameters
hour The hour setting for the dynamic date time.

public abstract void setDynamicMinute (int minute)

Sets the minute setting for the dynamic date time.

Parameters
minute The minute setting for the dynamic date time.

public abstract void setDynamicMonth (int month)

Sets the month setting for the dynamic date. This should be a value from EnumDSSXMLMonth.

Parameters
month The month setting for the dynamic date.

public abstract void setDynamicMonthOffset (int offset)

Sets the dynamic month offset.

Parameters
offset The new value for the offset.

public abstract void setDynamicSecond (int second)

Sets the second setting for the dynamic date time.

Parameters
second The second setting for the dynamic date time.

public abstract void setDynamicTimeType (int type)

Sets the dynamic time type. This tells the general type of qualification. The value must be from EnumDSSXMLDynamicTime.

Parameters
type The new value for the dynamic time type, from EnumDSSXMLDynamicTime.

public abstract void setDynamicWeek (int week)

Sets the week setting for the dynamic date.

Parameters
week The week setting for the dynamic date.

public abstract void setDynamicYear (int year)

Sets the year setting for the dynamic date.

Parameters
year The year setting for the dynamic date.

public abstract void setTime (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.