com.universaldevices.device.model
Class SystemOptions

java.lang.Object
  extended by com.universaldevices.device.model.SystemOptions

public class SystemOptions
extends java.lang.Object

This class represents SystemOptions for the system (ISY).

Author:
UD Architect

Field Summary
 boolean compactEmail
          Whether or not ISY sends compact e-mail notifications.
 int htmlRole
          Role of the html interface 1 - Read only 2 - Basic 3 - Advanced 4 - Admin
 boolean isNTPActive
          Whether or not NTP is active
 int ntpCheckInterval
          NTP check Interval in seconds
 boolean ntpEnabled
          Whether or not NTP is enabled
 java.lang.String ntpHost
          NTP Host
 boolean programCatchUp
          Whether or not ISY catches up all programs upon reboot
 int programGracePeriod
          The grace period during which time a schedule is still considered true
 boolean queryOnInit
          Whether or not ISY should query the system at restart
 java.lang.String to
          A list of addresses to which notifications are sent
 boolean waitBusy
          Whether or not we should wait while ISY is reading
 
Constructor Summary
SystemOptions(java.lang.String conf)
          Constructor
SystemOptions(java.lang.String to, boolean compactEmail, boolean queryOnInit, boolean waitBusy, boolean programCatchUp, int programGracePeriod, int htmlRole)
          Constructor
SystemOptions(java.lang.String ntpHost, int ntpCheckInterval, boolean ntpEnabled)
          Constructor
 
Method Summary
 boolean equals(SystemOptions nc)
          Tests for equality
 java.lang.StringBuffer toDIML()
          Converts this object to its DIML/XML counterpart
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

to

public java.lang.String to
A list of addresses to which notifications are sent

A comma delimited list of email/sms addresses to which notifications shall be sent
defaults to null


htmlRole

public int htmlRole
Role of the html interface

Default is Basic


compactEmail

public boolean compactEmail
Whether or not ISY sends compact e-mail notifications.

Default is false


queryOnInit

public boolean queryOnInit
Whether or not ISY should query the system at restart

Default is false


waitBusy

public boolean waitBusy
Whether or not we should wait while ISY is reading


programCatchUp

public boolean programCatchUp
Whether or not ISY catches up all programs upon reboot

Default is true


programGracePeriod

public int programGracePeriod
The grace period during which time a schedule is still considered true


ntpHost

public java.lang.String ntpHost
NTP Host


isNTPActive

public boolean isNTPActive
Whether or not NTP is active


ntpEnabled

public boolean ntpEnabled
Whether or not NTP is enabled


ntpCheckInterval

public int ntpCheckInterval
NTP check Interval in seconds

Constructor Detail

SystemOptions

public SystemOptions(java.lang.String conf)
Constructor

Creates a SystemOptions object from the DIML/XML representation as returned by the system (ISY). Note: this constructor is called by UD Network and Services Layer and, as such, should not be invoked independently

Parameters:
conf - - the XML/UDML representation of SystemOptions

SystemOptions

public SystemOptions(java.lang.String to,
                     boolean compactEmail,
                     boolean queryOnInit,
                     boolean waitBusy,
                     boolean programCatchUp,
                     int programGracePeriod,
                     int htmlRole)
Constructor

Creates a SystemOptions object from the given parameters

Parameters:
to - - a comma delimited list of email/sms addresses to which the notifications are sent
compactEmail - - whether or not ISY should send full or compact e-mail notifications
queryOnInit - - whether or not ISY should query all devices upon Restart
programCatchUp - - whether or not ISY should catchup with all programs upon reboot
programGracePeriod - - the period during which ISY considers a schedule still valid
htmlRole - - what level of role does the HTML user have


SystemOptions

public SystemOptions(java.lang.String ntpHost,
                     int ntpCheckInterval,
                     boolean ntpEnabled)
Constructor

Creates a SystemOptions object from the given parameters for saving NTP settings

Parameters:
ntpHost - - the NTP server URL
ntpCheckInterval - - the interval (in seconds) to synch with NTP
ntpEnabled - - whether or not ntp is enabled schedule still valid

Method Detail

toDIML

public java.lang.StringBuffer toDIML()
Converts this object to its DIML/XML counterpart

Returns:
the DIML representation of this object

equals

public boolean equals(SystemOptions nc)
Tests for equality

Returns whether or not this object is equal to the given parameter

Parameters:
nc - - the other NotificationConfiguration which is checked for equality
Returns:
true if equal, false otherwise