com.microstrategy.usher

Class TimeRestrictionModel

java.lang.Object

com.microstrategy.usher.TimeRestrictionModel

public abstract class TimeRestrictionModel
extends java.lang.Object

The TimeRestrictionModel abstract class identifies the properties related to badge enablement time restrictions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeRestrictionModel.Item The TimeRestrictionModel.Item abstract class identifies the properties related to badge enablement time restrictions, such as when they start and end.

Method Summary

Modifier and Type	Method and Description
abstract java.util.List<TimeRestrictionModel.Item>	availableItemList() Returns a List of TimeRestrictionModel.Item objects.
abstract java.lang.String	availableSessionDisplayValue() Returns a String of all of the time intervals during which a badge is not subject to a badge enablement time restriction.
abstract float	degreeOfNowInSeconds() Returns a float of the current time in seconds as a function of degrees of a circle.
abstract boolean	isDeniedAllDay() Returns a boolean that represents whether or not the badge is restricted for the entire day.
abstract long	nowInSeconds() Returns a long of the current time in seconds.
abstract double	radianOfNowInSeconds() Returns a float of the current time in seconds as a function of radians of a circle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

availableItemList

@Nullable
public abstract java.util.List<TimeRestrictionModel.Item> availableItemList()

Returns a List of TimeRestrictionModel.Item objects. May be null.

Returns:

a List of TimeRestrictionModel.Item objects.

isDeniedAllDay

public abstract boolean isDeniedAllDay()

Returns a boolean that represents whether or not the badge is restricted for the entire day.

Returns:

true if the badge is restricted for the entire day; false otherwise.

nowInSeconds

public abstract long nowInSeconds()

Returns a long of the current time in seconds.

Returns:

the current time in seconds.

availableSessionDisplayValue

@Nullable
public abstract java.lang.String availableSessionDisplayValue()

Returns a String of all of the time intervals during which a badge is not subject to a badge enablement time restriction.

Returns:

all of the time intervals during which a badge is not subject to a badge enablement time restriction.

degreeOfNowInSeconds

public abstract float degreeOfNowInSeconds()

Returns a float of the current time in seconds as a function of degrees of a circle. For example, 00:00, which is 0% of the day, would be 0 degrees (0% of 360 degrees) and placed at the top of the circle. 12:00, which is 50% of the day, would be 180 degrees (50% of 360 degrees) and placed at the bottom of the circle. The circle increases degrees in a clockwise manner.

Returns:

the current time in seconds as a function of degrees of a circle.

radianOfNowInSeconds

public abstract double radianOfNowInSeconds()

Returns a float of the current time in seconds as a function of radians of a circle. For example, 00:00, which is 0% of the day, would be 0 radians (0% of 2*pi radians) and placed at the top of the circle. 12:00, which is 50% of the day, would be pi radians (50% of 2*pi radians) and placed at the bottom of the circle. The circle increases radians in a clockwise manner.

Returns:

the current time in seconds as a function of radians of a circle.