com.microstrategy.usher

Class OrgConfigEntity.TimeRestrictionItem

java.lang.Object

com.microstrategy.usher.OrgConfigEntity.TimeRestrictionItem

Enclosing class:

OrgConfigEntity

public abstract static class OrgConfigEntity.TimeRestrictionItem
extends java.lang.Object

The OrgConfigEntity.TimeRestrictionItem abstract class identifies the properties related to badge enablement time restrictions on a daily scale that will be parsed from the JSON String returned from the server. Here is an example:
"{\"time_zone\":\"America\\/Halifax\",\"weekly\":[{\"week_days\":[1],\"start_time\":\"0800\",\"end_time\":\"2000\"},{\"week_days\":[2],\"start_time\":\"0900\",\"end_time\":\"2100\"},{\"week_days\":[3,4,5],\"start_time\":\"1500\",\"end_time\":\"2200\"},{\"week_days\":[2],\"start_time\":\"1430\",\"end_time\":\"1530\"}]}"
Here are the time periods that the badge will work in (in Atlantic Standard Time):

• Sunday: none
• Monday: 0800-2000
• Tuesday: 0900-2100, 1430-1530
• Wednesday: 1500-2200
• Thursday: 1500-2200
• Friday: 1500-2200
• Saturday: none

Method Summary

Modifier and Type	Method and Description
abstract java.util.List<java.lang.Integer>	getDays() Returns a List of Integer objects of the indices of the days of the week that are affected by that particular badge enablement time restriction.
abstract java.lang.String	getEndTime() Returns a String of the end time of that particular badge enablement time restriction.
abstract java.lang.String	getStartTime() Returns a String of the start time of that particular badge enablement time restriction.

Methods inherited from class java.lang.Object

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

Method Detail

getDays

public abstract java.util.List<java.lang.Integer> getDays()

Returns a List of Integer objects of the indices of the days of the week that are affected by that particular badge enablement time restriction.

Returns:

a List of Integer objects of the indices of the days of the week that are affected by that particular badge enablement time restriction.

getStartTime

public abstract java.lang.String getStartTime()

Returns a String of the start time of that particular badge enablement time restriction.

Returns:

the start time of that particular badge enablement time restriction.

getEndTime

public abstract java.lang.String getEndTime()

Returns a String of the end time of that particular badge enablement time restriction.

Returns:

the end time of that particular badge enablement time restriction.