com.microstrategy.usher

Class OrgConfigEntity.TimeRestrictionEntity

java.lang.Object

com.microstrategy.usher.OrgConfigEntity.TimeRestrictionEntity

Enclosing class:

OrgConfigEntity

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

The OrgConfigEntity.TimeRestrictionEntity abstract class identifies the properties related to badge enablement time restrictions on a weekly 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<OrgConfigEntity.TimeRestrictionItem>	timeRestrictionItemList() Returns a List of OrgConfigEntity.TimeRestrictionItem objects that identify the properties related to badge enablement time restrictions on a daily scale that will be parsed from the JSON String returned from the server.
abstract java.lang.String	timeZone() Returns a String of the time zone.

Methods inherited from class java.lang.Object

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

Method Detail

timeZone

public abstract java.lang.String timeZone()

Returns a String of the time zone.

Returns:

the time zone.

timeRestrictionItemList

public abstract java.util.List<OrgConfigEntity.TimeRestrictionItem> timeRestrictionItemList()

Returns a List of OrgConfigEntity.TimeRestrictionItem objects that identify the properties related to badge enablement time restrictions on a daily scale that will be parsed from the JSON String returned from the server.

Returns:

a List of OrgConfigEntity.TimeRestrictionItem objects.