org.opengts.db
Class BasicPrivateLabel

java.lang.Object
  extended by org.opengts.db.BasicPrivateLabel
All Implemented Interfaces:
RTConfig.PropertySetter
Direct Known Subclasses:
PrivateLabel

public class BasicPrivateLabel
extends java.lang.Object
implements RTConfig.PropertySetter


Field Summary
protected static boolean _isTrackServlet
           
static java.lang.String ALL_HOSTS
           
static java.lang.String DEFAULT_HOST
           
static java.lang.String EMAIL_TYPE_ACCOUNTS
           
static java.lang.String EMAIL_TYPE_COMMAND
           
static java.lang.String EMAIL_TYPE_DEFAULT
           
static java.lang.String EMAIL_TYPE_NOTIFY
           
static java.lang.String EMAIL_TYPE_PASSWORD
           
static java.lang.String EMAIL_TYPE_SUPPORT
           
static java.lang.String LAF_Background_Color
           
static java.lang.String LAF_Background_Image
           
static java.lang.String LAF_Background_Position
           
static java.lang.String LAF_Background_Repeat
           
static java.lang.String LAF_Banner_AnchorLink
           
static java.lang.String LAF_Banner_ImageHeight
           
static java.lang.String LAF_Banner_ImageSource
           
static java.lang.String LAF_Banner_ImageWidth
           
static java.lang.String LAF_Banner_Style
           
static java.lang.String LAF_Banner_Width
           
static java.lang.String LAF_ContentCell_Color
           
static java.lang.String LAF_Copyright
           
static java.lang.String LAF_IconMenu_GroupTitle_Color
           
static java.lang.String LAF_JSPEntry_
           
static java.lang.String LAF_JSPEntry_Default
           
static java.lang.String LAF_PageTitle
           
static java.lang.String PROP_AccountLogin_legacyLAF
           
static java.lang.String PROP_AccountLogin_showLocaleSelection
           
static java.lang.String PROP_AccountLogin_showLoginLink
           
static java.lang.String PROP_Banner_imageHeight
           
static java.lang.String PROP_Banner_imageLink
           
static java.lang.String PROP_Banner_imageSource
           
static java.lang.String PROP_Banner_imageWidth
           
static java.lang.String PROP_Banner_style
           
static java.lang.String PROP_Banner_width
           
static java.lang.String PROP_Calendar_firstDayOfWeek
           
static java.lang.String PROP_Calendar_timeTextField
           
static java.lang.String PROP_CorridorInfo_enableGeocode
           
static java.lang.String PROP_CorridorInfo_enableGeocode_country
           
static java.lang.String PROP_CorridorInfo_mapControlLocation
           
static java.lang.String PROP_CorridorInfo_pointCount
           
static java.lang.String PROP_CorridorInfo_showShapeColor
           
static java.lang.String PROP_DeviceAlerts_mapPageName
           
static java.lang.String PROP_DeviceAlerts_maxActiveAlertAge
           
static java.lang.String PROP_DeviceAlerts_refreshInterval
           
static java.lang.String PROP_DeviceAlerts_showAllDevices
           
static java.lang.String PROP_DeviceChooser_extraDebugEntries
           
static java.lang.String PROP_DeviceChooser_idPosition
           
static java.lang.String PROP_DeviceChooser_includeListHtml
           
static java.lang.String PROP_DeviceChooser_matchContains
           
static java.lang.String PROP_DeviceChooser_search
           
static java.lang.String PROP_DeviceChooser_singleItemTextField
           
static java.lang.String PROP_DeviceChooser_sortBy
           
static java.lang.String PROP_DeviceChooser_useTable
           
static java.lang.String PROP_DeviceInfo_allowDeleteDevice
           
static java.lang.String PROP_DeviceInfo_allowEditFirmwareVersion
           
static java.lang.String PROP_DeviceInfo_allowEditServerID
           
static java.lang.String PROP_DeviceInfo_allowNewDevice
           
static java.lang.String PROP_DeviceInfo_custom_
           
static java.lang.String PROP_DeviceInfo_maximumIgnitionIndex
           
static java.lang.String PROP_DeviceInfo_optimizeUpdateDevice
           
static java.lang.String PROP_DeviceInfo_showAssignedUserID
           
static java.lang.String PROP_DeviceInfo_showCommandState_
           
static java.lang.String PROP_DeviceInfo_showDataKey
           
static java.lang.String PROP_DeviceInfo_showDateCalendar
           
static java.lang.String PROP_DeviceInfo_showDcsConfigString
           
static java.lang.String PROP_DeviceInfo_showDcsPropertiesID
           
static java.lang.String PROP_DeviceInfo_showDisplayColor
           
static java.lang.String PROP_DeviceInfo_showExpectedAcks
           
static java.lang.String PROP_DeviceInfo_showFaultCodes
           
static java.lang.String PROP_DeviceInfo_showFixedLocation
           
static java.lang.String PROP_DeviceInfo_showFuelCapacity
           
static java.lang.String PROP_DeviceInfo_showFuelLevelProfile
           
static java.lang.String PROP_DeviceInfo_showHoursOfOperation
           
static java.lang.String PROP_DeviceInfo_showIgnitionIndex
           
static java.lang.String PROP_DeviceInfo_showInputState_
           
static java.lang.String PROP_DeviceInfo_showMaintenanceHours
           
static java.lang.String PROP_DeviceInfo_showMaintenanceNotes
           
static java.lang.String PROP_DeviceInfo_showMaintenanceOdometer
           
static java.lang.String PROP_DeviceInfo_showNotes
           
static java.lang.String PROP_DeviceInfo_showNotificationFields
           
static java.lang.String PROP_DeviceInfo_showOutputState_
           
static java.lang.String PROP_DeviceInfo_showPreferredGroupID
           
static java.lang.String PROP_DeviceInfo_showPropertiesButton
           
static java.lang.String PROP_DeviceInfo_showPushpinChooser
           
static java.lang.String PROP_DeviceInfo_showPushpinID
           
static java.lang.String PROP_DeviceInfo_showReminderMessage
           
static java.lang.String PROP_DeviceInfo_showReportedEngineHours
           
static java.lang.String PROP_DeviceInfo_showReportedOdometer
           
static java.lang.String PROP_DeviceInfo_showServiceTime
           
static java.lang.String PROP_DeviceInfo_showSmsButton
           
static java.lang.String PROP_DeviceInfo_SMS_useDeviceSMSCommands
           
static java.lang.String PROP_DeviceInfo_uniqueSimPhoneNumber
           
static java.lang.String PROP_DriverInfo_showDateCalendar
           
static java.lang.String PROP_DriverInfo_showDeviceID
           
static java.lang.String PROP_EntityAdmin_entityType
           
static java.lang.String PROP_FullMap_autoUpdateRecenter
           
static java.lang.String PROP_FullMap_calendarAction
           
static java.lang.String PROP_FullMap_calendarDateOnLoad
           
static java.lang.String PROP_FullMap_detailAscending
           
static java.lang.String PROP_FullMap_detailCenterPushpin
           
static java.lang.String PROP_FullMap_enableGeocode
           
static java.lang.String PROP_FullMap_enableGeocode_country
           
static java.lang.String PROP_FullMap_fleetDeviceEventCount
           
static java.lang.String PROP_FullMap_lastDevicePushpin_device
           
static java.lang.String PROP_FullMap_lastDevicePushpin_fleet
           
static java.lang.String PROP_FullMap_limitType
           
static java.lang.String PROP_FullMap_mapControlCollapsible
           
static java.lang.String PROP_FullMap_mapControlLocation
           
static java.lang.String PROP_FullMap_mapUpdateOnLoad
           
static java.lang.String PROP_FullMap_pageLinks
           
static java.lang.String PROP_FullMap_showAllContainedGeozones
           
static java.lang.String PROP_FullMap_showBatteryLevel
           
static java.lang.String PROP_FullMap_showCursorLocation
           
static java.lang.String PROP_FullMap_showDeviceLink
           
static java.lang.String PROP_FullMap_showDistanceRuler
           
static java.lang.String PROP_FullMap_showFleetMapDevicePushpin
           
static java.lang.String PROP_FullMap_showGoogleKML
           
static java.lang.String PROP_FullMap_showLegend
           
static java.lang.String PROP_FullMap_showLocateNow
           
static java.lang.String PROP_FullMap_showPushpinReplay
           
static java.lang.String PROP_FullMap_showTimezoneSelection
           
static java.lang.String PROP_FullMap_showUpdateAll
           
static java.lang.String PROP_FullMap_showUpdateLast
           
static java.lang.String PROP_FullMap_useRouteDisplayColor
           
static java.lang.String PROP_GroupInfo_deviceListSortBy
           
static java.lang.String PROP_GroupInfo_showPropertiesButton
           
static java.lang.String PROP_MenuBar_includeTextAnchor
           
static java.lang.String PROP_MenuBar_openOnMouseOver
           
static java.lang.String PROP_MenuBar_usePullDownMenus
           
static java.lang.String PROP_NewAccount_authCodeMask
           
static java.lang.String PROP_ReportDisplay_showGoogleKML
           
static java.lang.String PROP_ReportMenu_customFormatURL
           
static java.lang.String PROP_ReportMenu_enableReportEmail
           
static java.lang.String PROP_ReportMenu_enableReportSchedule
           
static java.lang.String PROP_ReportMenu_showTimezoneSelection
           
static java.lang.String PROP_ReportMenu_useMapDates
           
static java.lang.String PROP_RuleInfo_ruleTagList
           
static java.lang.String PROP_RuleInfo_showCronRules
           
static java.lang.String PROP_RuleInfo_showEMailWrapper
           
static java.lang.String PROP_RuleInfo_showPredefinedActions
           
static java.lang.String PROP_RuleInfo_showSysRules
           
static java.lang.String PROP_RuleInfo_showSysRulesOnly
           
static java.lang.String PROP_RuleInfo_showTriggerActions
           
static java.lang.String PROP_StatusCodeInfo_showIconSelector
           
static java.lang.String PROP_StatusCodeInfo_showPushpinChooser
           
static java.lang.String PROP_SysAccountsLogin_enableLogin
           
static java.lang.String PROP_SysAccountsLogin_enableReturn
           
static java.lang.String PROP_SysAccountsLogin_enableReturn_timeout
           
static java.lang.String PROP_SysAccountsLogin_passcode
           
static java.lang.String PROP_SysAdminAccounts_accountProperties
           
static java.lang.String PROP_SysAdminAccounts_allowDeleteAccount
           
static java.lang.String PROP_SysAdminAccounts_showAccountManager
           
static java.lang.String PROP_SysAdminAccounts_showAllowWebService
           
static java.lang.String PROP_SysAdminAccounts_showAutoAddDevices
           
static java.lang.String PROP_SysAdminAccounts_showDataPushURL
           
static java.lang.String PROP_SysAdminAccounts_showNotes
           
static java.lang.String PROP_SysAdminAccounts_showPasswords
           
static java.lang.String PROP_SysAdminAccounts_showRetainEvents
           
static java.lang.String PROP_SysAdminInfo_showEventCount
           
static java.lang.String PROP_SysAdminInfo_showEventsPerSecond
           
static java.lang.String PROP_TopMenu_maximumIconsPerRow
           
static java.lang.String PROP_TopMenu_menuType
           
static java.lang.String PROP_TopMenu_showHeader
           
static java.lang.String PROP_TopMenu_showMenuDescription
           
static java.lang.String PROP_TopMenu_showMenuHelp
           
static java.lang.String PROP_Track_editAfterNew
           
static java.lang.String PROP_Track_enableAuthenticationService
           
static java.lang.String PROP_Track_firstLoginPageID
           
static java.lang.String PROP_Track_forwardToSecureAccess
           
static java.lang.String PROP_Track_ValidateIDs
           
static java.lang.String PROP_TrackMap_autoUpdateRecenter
           
static java.lang.String PROP_TrackMap_calendarAction
           
static java.lang.String PROP_TrackMap_calendarDateOnLoad
           
static java.lang.String PROP_TrackMap_detailAscending
           
static java.lang.String PROP_TrackMap_detailCenterPushpin
           
static java.lang.String PROP_TrackMap_enableGeocode
           
static java.lang.String PROP_TrackMap_enableGeocode_country
           
static java.lang.String PROP_TrackMap_fleetDeviceEventCount
           
static java.lang.String PROP_TrackMap_includeStatusCodeColor
           
static java.lang.String PROP_TrackMap_lastDevicePushpin_device
           
static java.lang.String PROP_TrackMap_lastDevicePushpin_fleet
           
static java.lang.String PROP_TrackMap_limitType
           
static java.lang.String PROP_TrackMap_mapControlCollapseOnLoad
           
static java.lang.String PROP_TrackMap_mapControlCollapsible
           
static java.lang.String PROP_TrackMap_mapControlLocation
           
static java.lang.String PROP_TrackMap_mapUpdateOnLoad
           
static java.lang.String PROP_TrackMap_pageLinks
           
static java.lang.String PROP_TrackMap_showAllContainedGeozones
           
static java.lang.String PROP_TrackMap_showBatteryLevel
           
static java.lang.String PROP_TrackMap_showCursorLocation
           
static java.lang.String PROP_TrackMap_showDeviceLink
           
static java.lang.String PROP_TrackMap_showDistanceRuler
           
static java.lang.String PROP_TrackMap_showFleetMapDevicePushpin
           
static java.lang.String PROP_TrackMap_showGoogleKML
           
static java.lang.String PROP_TrackMap_showLegend
           
static java.lang.String PROP_TrackMap_showLocateNow
           
static java.lang.String PROP_TrackMap_showLocationDetails
           
static java.lang.String PROP_TrackMap_showNearbyGeozones
           
static java.lang.String PROP_TrackMap_showPushpinReplay
           
static java.lang.String PROP_TrackMap_showTimezoneSelection
           
static java.lang.String PROP_TrackMap_showUpdateAll
           
static java.lang.String PROP_TrackMap_showUpdateLast
           
static java.lang.String PROP_TrackMap_sortableLocationDetails
           
static java.lang.String PROP_TrackMap_useRouteDisplayColor
           
static java.lang.String PROP_UserInfo_allowDuplicateContactEmail
           
static java.lang.String PROP_UserInfo_authorizedGroupCount
           
static java.lang.String PROP_UserInfo_custom_
           
static java.lang.String PROP_UserInfo_showAccessControlList
           
static java.lang.String PROP_UserInfo_showAddressFields
           
static java.lang.String PROP_UserInfo_showNotes
           
static java.lang.String PROP_UserInfo_showOfficeLocation
           
static java.lang.String PROP_UserInfo_showPassword
           
static java.lang.String PROP_UserInfo_showPreferredDeviceID
           
static java.lang.String PROP_WorkZoneInfo_mapControlLocation
           
static java.lang.String PROP_ZoneInfo_enableGeocode
           
static java.lang.String PROP_ZoneInfo_enableGeocode_country
           
static java.lang.String PROP_ZoneInfo_mapControlLocation
           
static java.lang.String PROP_ZoneInfo_maximumDisplayedVertices
           
static java.lang.String PROP_ZoneInfo_showArriveDepartCode
           
static java.lang.String PROP_ZoneInfo_showArriveDepartZone
           
static java.lang.String PROP_ZoneInfo_showAssignedDeviceGroup
           
static java.lang.String PROP_ZoneInfo_showAutoNotify
           
static java.lang.String PROP_ZoneInfo_showClientUploadZone
           
static java.lang.String PROP_ZoneInfo_showCorridorID
           
static java.lang.String PROP_ZoneInfo_showOverlapPriority
           
static java.lang.String PROP_ZoneInfo_showPurposeID
           
static java.lang.String PROP_ZoneInfo_showPushpins
           
static java.lang.String PROP_ZoneInfo_showReverseGeocodeZone
           
static java.lang.String PROP_ZoneInfo_showShapeColor
           
static java.lang.String PROP_ZoneInfo_showSpeedLimit
           
static java.lang.String PROP_ZoneInfo_zonePurposeList
           
static java.lang.String RGNAME_ACTIVE
           
static java.lang.String TIMEZONE_CONF
           
 
Constructor Summary
protected BasicPrivateLabel()
          Constructor
  BasicPrivateLabel(java.lang.String host)
          Constructor
 
Method Summary
 void addAclMap(AclEntry.AccessLevel dftAccess, java.util.Map<java.lang.String,AclEntry> aclMap)
          Sets the user Access-Control for this BasicPrivateLabel
 void addGeocodeProvider(GeocodeProvider gp, boolean active)
          Sets the GeocodeProvider for this BasicPrivateLabel
 void addHostAlias(java.lang.String host, java.lang.String desc)
          Adds a host alias to this BasicPrivateLabel
 void addMobileLocationProvider(org.opengts.cellid.MobileLocationProvider mp)
          Sets the MobileLocationProvider for this BasicPrivateLabel
 void addReverseGeocodeProvider(ReverseGeocodeProvider rgp, boolean active)
          Sets the ReverseGeocodeProvider for this BasicPrivateLabel
 void addStatusCode(StatusCodes.Code code)
          Adds a customized status code description override
 void clearTimeZones()
          Clears TimeZone cache
 AclEntry.AccessLevel getAccessLevel(Role role, java.lang.String aclName)
          Returns the AccessLevel for the specified ACL key
 AclEntry.AccessLevel getAccessLevel(User user, java.lang.String aclName)
          Returns true is user has 'ALL' access rights for the specified ACL key
 boolean getAccountLogin()
          Gets the account login display state
 AclEntry getAclEntry(java.lang.String aclName)
          Returns the AclEntry for the specified key
 AclEntry[] getAllAclEntries()
          Returns all defined AclEntries
 boolean getAllowEmailLogin()
          Gets the Enabled/Disabled contact-email login state
static java.lang.String[] getAllTimeZones()
          Returns an array of all possible TimeZone names
 boolean getBooleanProperty(java.lang.String key, boolean dft)
          Gets the boolean property value for the specified key
 java.lang.String getCopyright()
          Gets the copyright notice for this BasicPrivateLabel
 java.util.Map<java.lang.Integer,StatusCodes.Code> getCustomStatusCodeMap()
          Returns a Map of custom status codes
 java.lang.String getDateFormat()
          Gets the date format for this BasicPrivateLabel
 DateTime.DateStringFormat getDateStringFormat()
          Gets the DateStringFormat enumerated type
 DateTime.DateStringFormat getDateStringFormat(java.lang.String dateFormat)
          Gets the DateStringFormat enumerated type
 java.lang.String getDateStringFormatText(java.util.Locale locale)
          Gets the DateStringFormat enumerated type
 AclEntry.AccessLevel getDefaultAccessLevel()
          Gets the global default access-control level for this BasicPrivateLabel
 AclEntry.AccessLevel getDefaultAccessLevel(java.lang.String aclName)
          Gets the default access-control level for this BasicPrivateLabel
 java.lang.String getDefaultBaseURL()
          Gets the default BaseURL (or null if no base URL is defined)
static java.lang.String getDefaultDateFormat()
          Gets the default date format
 java.lang.String getDefaultLoginAccount()
          Gets the default login account name
 java.lang.String getDefaultLoginUser()
          Gets the default login user name
static java.lang.String getDefaultTimeFormat()
          Gets the default time format
 java.lang.String getDomainName()
          Gets the host alias name
 double getDoubleProperty(java.lang.String key, double dft)
          Gets the double property value for the specified key
 java.lang.String getEMailAddress(java.lang.String type)
          Gets the 'From' EMail address for the specified type
 java.lang.String[] getEMailAddresses()
          Returns an array of all defined EMail addresses (used by CHeckInstall)
 boolean getEnableDemo()
          Returns true if this BasicPrivateLabel supports a 'demo' mode
 java.lang.String getEventNotificationBody()
          Gets the EMail notification message 'Body'
 boolean getEventNotificationDefault()
          Returns true if the email notification subject/body is to be used as the default entry for new created Rule definitions.
 java.lang.String getEventNotificationFrom()
          Gets the EMail notification 'From' address
 java.lang.String getEventNotificationSubject()
          Gets the EMail notification 'Subject'
 GeocodeProvider getGeocodeProvider()
          Returns the active GeocodeProvider for this BasicPrivatelabel
 GeocodeProvider getGeocodeProvider(java.lang.String name)
          Returns the named GeocodeProvider for this BasicPrivatelabel
 java.util.List<java.lang.String> getHostAliasNames()
          Gets the list of host name aliases
 java.lang.String getHostName()
          Gets the primary host name associated with this BasicPrivateLabel
 I18N getI18N(java.lang.Class clazz)
          Gets the I18N instance for the specified class using the Locale associated with this BasicPrivateLabel
 I18N getI18N(java.lang.Package pkg)
          Gets the I18N instance for the specified package using the Locale associated with this BasicPrivateLabel
 java.lang.String getI18NTextString(java.lang.String key, java.lang.String dft)
          Gets the Localized text for the specified String key
 int getIntProperty(java.lang.String key, int dft)
          Gets the int property value for the specified key
 java.util.Locale getLocale()
          Gets the Locale for the current locale String code
 java.lang.String getLocaleString()
          Gets the locale String code for this BasicPrivateLabel
 long getLongProperty(java.lang.String key, long dft)
          Gets the long property value for the specified key
 AclEntry.AccessLevel getMaximumAccessLevel(java.lang.String aclName)
          Gets the maximum access-control level for this BasicPrivateLabel
 org.opengts.cellid.MobileLocationProvider getMobileLocationProvider()
          Returns the active MobileLocationProvider for this BasicPrivatelabel
 org.opengts.cellid.MobileLocationProvider getMobileLocationProvider(java.lang.String name)
          Returns the named MobileLocationProvider for this BasicPrivatelabel
 java.lang.String getName()
          Gets the name of this BasicPrivateLabel.
 java.lang.String getPageTitle()
          Gets the HTML page title for this BasicPrivateLabel
 PasswordHandler getPasswordHandler()
          Gets the PasswordHandler for this Domain
 java.util.List<PoiProvider> getPointsOfInterest()
          Gets the global PointsOfInterest (overridden)
 PredefinedRuleAction[] getPredefinedRuleActions()
          Gets the list of PredefinedRuleActions
 java.lang.Object getProperty(java.lang.String key)
          Gets the property value for the specified key
 java.util.Collection<java.lang.String> getPropertyKeys(java.lang.String keyPrefix)
          Gets the property keys matching the specified key prefix
 int getPushpinIconIndex(java.lang.String pushpinID, int dftIndex)
          Return the MapProvider's Pushpin index for the specified pushpin ID
 int getPushpinIconIndex(java.lang.String mapProviderID, java.lang.String pushpinID, int dftIndex)
          Return the MapProvider's Pushpin index for the specified pushpin ID
 ReverseGeocodeProvider getReverseGeocodeProvider()
          Returns the active ReverseGeocodeProvider for this BasicPrivatelabel
 ReverseGeocodeProvider getReverseGeocodeProvider(java.lang.String name)
          Returns the named ReverseGeocodeProvider for this BasicPrivatelabel
 RTProperties getRTProperties()
          Gets the properties of this BasicPrivateLabel
 boolean getShowPassword()
          Returns true if the password field is to be made visible
 SendMail.SmtpProperties getSmtpProperties()
          Get SMTP server properties
 StatusCodes.Code getStatusCode(int code)
          Return specific code (from statusCode)
 StatusCodes.Code getStatusCode(java.lang.Integer code)
          Return specific code (from statusCode)
 OrderedMap<java.lang.Integer,java.lang.String> getStatusCodeDescriptionMap()
          Returns a Map of StatusCodes to their desriptions
 OrderedSet<java.lang.Integer> getStatusCodeList()
          Returns a Set of StatusCodes
 boolean getStatusCodeOnly()
          Gets the exclusive status codes state
 java.lang.String getStringProperty(java.lang.String key, java.lang.String dft)
          Gets the String property value for the specified key
static java.util.Map<java.lang.String,java.lang.String> GetSupportedLocaleMap(java.util.Locale locale)
          Gets a map of supported locales
 java.lang.String getSystemAccountsLoginPasscode(java.lang.String acctID)
          Gets the SystemAccountsLogin passcode
 long getSystemAccountsLoginReturnTimeout(java.lang.String acctID)
          Gets the SystemAccountsLogin timeout (in seconds)
 java.lang.String getTimeFormat()
          Gets the time format for this BasicPrivateLabel
 java.lang.String[] getTimeZones()
          Gets an array of supported TimeZones
 java.lang.String[] getTimeZonesArray()
          Gets the list of supported TimeZones
 java.util.List<java.lang.String> getTimeZonesList()
          Gets the list of supported TimeZones
 boolean getUserLogin()
          Gets the user login display state
 boolean globalEditAfterNew()
          Returns true if all IDs should be validated for proper characters
 boolean globalValidateIDs()
          Returns true if all IDs should be validated for proper characters
 boolean hasAclEntry(java.lang.String aclName)
          Returns true if the AclEntry key is defined
 boolean hasAllAccess(User user, java.lang.String aclName)
          Returns true is user has 'ALL' access rights for the specified ACL key
 boolean hasDefaultBaseURL()
          Returns true if a base URL has been defined
 boolean hasEventNotificationEMail()
          Return true if the notification subject and/or message is defined
 boolean hasProperty(java.lang.String key)
          Returns true if the property key is defined by thie BasicPrivateLabel
 boolean hasReadAccess(User user, java.lang.String aclName)
          Returns true is user has 'READ' access rights for the specified ACL key
static boolean HasSupportedLocalesMap()
          Returns true if a set of supported Locales is defined
 boolean hasWriteAccess(User user, java.lang.String aclName)
          Returns true is user has 'WRITE' access rights for the specified ACL key
 boolean isDateFormatDMY()
          Return true if date format is DMY, false otherwise
 boolean isDateFormatMDY()
          Return true if date format is MDY, false otherwise
 boolean isDateFormatYMD()
          Return true if date format is YMD, false otherwise
 boolean isRestricted()
          Returns true this is BasicPrivateLabel has restricted access
 boolean isSystemAccountsLoginEnabled(java.lang.String acctID)
          Returns true if SystemAccountsLogin is enabled
 boolean isSystemAccountsLoginReturnEnabled(java.lang.String acctID)
          Returns true if SystemAccountsLogin Return is enabled
static boolean isTrackServlet()
           
 void popRTProperties()
          Pops the properties of this BasicPrivateLabel from the temporary RTConfig properties stack
 void postInitialization()
          Callback after load initialization
 void printProperties()
          Prints the current properties to stdout
 void printProperties(java.lang.String msg)
          Prints the current properties to stdout
 void pushRTProperties()
          Pushes the properties of this BasicPrivateLabel on the temporary RTConfig properties stack
 AclEntry removeAclEntry(java.lang.String aclName)
          Removes the AclEntry for the specified key
 void setAccountLogin(boolean acctLogin)
          Sets the account login display state
 void setAllowEmailLogin(boolean emailLogin)
          Sets the Enabled/Disabled contact-email login state
 void setCopyright(java.lang.String copyright)
          Sets the copyright notice for this BasicPrivateLabel
 void setDateFormat(java.lang.String dateFmt)
          Sets the date format for the current BasicPrivateLabel
 void setDefaultBaseURL(java.lang.String baseURL)
          Sets the default BaseURL (ie.
 void setDefaultLoginAccount(java.lang.String defaultAccount)
          Sets the default login account name
 void setDefaultLoginUser(java.lang.String defaultUser)
          Sets the default login user name
 void setDomainName(java.lang.String name)
          Sets the host alias name
 void setEMailAddress(java.lang.String type, java.lang.String emailAddr)
          Sets the default EMail 'From' addresses
 void setEnableDemo(boolean isDemo)
          Sets the 'demo' mode for this BasicPrivateLabel
 void setEventNotificationEMail(java.lang.String emailFrom, I18N.Text emailSubj, I18N.Text emailBody, boolean useAsDefault)
          Sets the event notification Email attributes
 void setHostName(java.lang.String host)
          Sets the primary host name associated with this BasicPrivateLabel
 void setI18NTextProperty(java.lang.String key, I18N.Text value)
          Sets the property I18N value for the specified key
 void setLocaleString(java.lang.String localeStr)
          Sets the locale String code for this BasicPrivateLabel
 void setPageTitle(I18N.Text text)
          Sets the title used on HTML pages displayed for this BasicPrivateLabel
 void setPageTitle(java.lang.String text)
          Sets the title used on HTML pages displayed for this BasicPrivateLabel
 void setPasswordHandler(PasswordHandler pwh)
          Sets the PasswordHandler for this Domain
 void setPredefinedRulesActions(PredefinedRuleAction[] predefRuleAct)
          Sets the list of PredefinedRuleActions
 void setProperty(java.lang.Object key, java.lang.Object value)
          Sets the property value for the specified key
 void setRestricted(boolean restricted)
          Sets the 'restricted mode' for this BasicPrivateLabel.
 void setRTProperties(RTProperties rtp)
          Sets (appends) the the specified properties to this BasicPrivateLabel
 void setShowPassword(boolean showPass)
          Sets whether to show the password, or not
 void setSmtpProperties(SendMail.SmtpProperties smtpProps)
          Set SMTP server properties
 void setStatusCodeOnly(boolean only)
          Sets the exclusive status codes state
 void setStringProperty(java.lang.String key, java.lang.String value)
          Sets the property String value for the specified key
static void SetSupportedLocalesMap(OrderedMap<java.lang.String,I18N.Text> localeMap)
          Sets the supported Locales
 void setTimeFormat(java.lang.String timeFmt)
          Sets the time format for this BasicPrivateLabel
 void setTimeZones(java.util.List<java.lang.String> tmz)
          Sets the TimeZones supported by this BasicPrivateLabel
 void setTimeZones(OrderedSet<java.lang.String> tmz)
          Sets the TimeZones supported by this BasicPrivateLabel
 void setTimeZones(java.lang.String[] tmz)
          Sets the TimeZones supported by this BasicPrivateLabel
static void setTrackServlet_loaderOnly()
           
 void setUserLogin(boolean userLogin)
          Sets the user login display state
 java.lang.String toString()
          Return String representation of this instance
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

EMAIL_TYPE_DEFAULT

public static final java.lang.String EMAIL_TYPE_DEFAULT
See Also:
Constant Field Values

EMAIL_TYPE_PASSWORD

public static final java.lang.String EMAIL_TYPE_PASSWORD
See Also:
Constant Field Values

EMAIL_TYPE_ACCOUNTS

public static final java.lang.String EMAIL_TYPE_ACCOUNTS
See Also:
Constant Field Values

EMAIL_TYPE_SUPPORT

public static final java.lang.String EMAIL_TYPE_SUPPORT
See Also:
Constant Field Values

EMAIL_TYPE_NOTIFY

public static final java.lang.String EMAIL_TYPE_NOTIFY
See Also:
Constant Field Values

EMAIL_TYPE_COMMAND

public static final java.lang.String EMAIL_TYPE_COMMAND
See Also:
Constant Field Values

TIMEZONE_CONF

public static final java.lang.String TIMEZONE_CONF
See Also:
Constant Field Values

ALL_HOSTS

public static final java.lang.String ALL_HOSTS
See Also:
Constant Field Values

DEFAULT_HOST

public static final java.lang.String DEFAULT_HOST
See Also:
Constant Field Values

LAF_PageTitle

public static final java.lang.String LAF_PageTitle
See Also:
Constant Field Values

LAF_Copyright

public static final java.lang.String LAF_Copyright
See Also:
Constant Field Values

LAF_JSPEntry_

public static final java.lang.String LAF_JSPEntry_
See Also:
Constant Field Values

LAF_JSPEntry_Default

public static final java.lang.String LAF_JSPEntry_Default
See Also:
Constant Field Values

LAF_Banner_Width

public static final java.lang.String LAF_Banner_Width
See Also:
Constant Field Values

LAF_Banner_Style

public static final java.lang.String LAF_Banner_Style
See Also:
Constant Field Values

LAF_Banner_ImageSource

public static final java.lang.String LAF_Banner_ImageSource
See Also:
Constant Field Values

LAF_Banner_ImageWidth

public static final java.lang.String LAF_Banner_ImageWidth
See Also:
Constant Field Values

LAF_Banner_ImageHeight

public static final java.lang.String LAF_Banner_ImageHeight
See Also:
Constant Field Values

LAF_Banner_AnchorLink

public static final java.lang.String LAF_Banner_AnchorLink
See Also:
Constant Field Values

LAF_Background_Color

public static final java.lang.String LAF_Background_Color
See Also:
Constant Field Values

LAF_Background_Image

public static final java.lang.String LAF_Background_Image
See Also:
Constant Field Values

LAF_Background_Position

public static final java.lang.String LAF_Background_Position
See Also:
Constant Field Values

LAF_Background_Repeat

public static final java.lang.String LAF_Background_Repeat
See Also:
Constant Field Values

LAF_ContentCell_Color

public static final java.lang.String LAF_ContentCell_Color
See Also:
Constant Field Values

LAF_IconMenu_GroupTitle_Color

public static final java.lang.String LAF_IconMenu_GroupTitle_Color
See Also:
Constant Field Values

PROP_Track_ValidateIDs

public static final java.lang.String PROP_Track_ValidateIDs
See Also:
Constant Field Values

PROP_Track_editAfterNew

public static final java.lang.String PROP_Track_editAfterNew
See Also:
Constant Field Values

PROP_Track_enableAuthenticationService

public static final java.lang.String PROP_Track_enableAuthenticationService
See Also:
Constant Field Values

PROP_Track_forwardToSecureAccess

public static final java.lang.String PROP_Track_forwardToSecureAccess
See Also:
Constant Field Values

PROP_Track_firstLoginPageID

public static final java.lang.String PROP_Track_firstLoginPageID
See Also:
Constant Field Values

PROP_NewAccount_authCodeMask

public static final java.lang.String PROP_NewAccount_authCodeMask
See Also:
Constant Field Values

PROP_AccountLogin_showLoginLink

public static final java.lang.String PROP_AccountLogin_showLoginLink
See Also:
Constant Field Values

PROP_AccountLogin_showLocaleSelection

public static final java.lang.String PROP_AccountLogin_showLocaleSelection
See Also:
Constant Field Values

PROP_AccountLogin_legacyLAF

public static final java.lang.String PROP_AccountLogin_legacyLAF
See Also:
Constant Field Values

PROP_MenuBar_openOnMouseOver

public static final java.lang.String PROP_MenuBar_openOnMouseOver
See Also:
Constant Field Values

PROP_MenuBar_usePullDownMenus

public static final java.lang.String PROP_MenuBar_usePullDownMenus
See Also:
Constant Field Values

PROP_MenuBar_includeTextAnchor

public static final java.lang.String PROP_MenuBar_includeTextAnchor
See Also:
Constant Field Values

PROP_TopMenu_menuType

public static final java.lang.String PROP_TopMenu_menuType
See Also:
Constant Field Values

PROP_TopMenu_showHeader

public static final java.lang.String PROP_TopMenu_showHeader
See Also:
Constant Field Values

PROP_TopMenu_maximumIconsPerRow

public static final java.lang.String PROP_TopMenu_maximumIconsPerRow
See Also:
Constant Field Values

PROP_TopMenu_showMenuDescription

public static final java.lang.String PROP_TopMenu_showMenuDescription
See Also:
Constant Field Values

PROP_TopMenu_showMenuHelp

public static final java.lang.String PROP_TopMenu_showMenuHelp
See Also:
Constant Field Values

PROP_DriverInfo_showDeviceID

public static final java.lang.String PROP_DriverInfo_showDeviceID
See Also:
Constant Field Values

PROP_DriverInfo_showDateCalendar

public static final java.lang.String PROP_DriverInfo_showDateCalendar
See Also:
Constant Field Values

PROP_DeviceInfo_allowNewDevice

public static final java.lang.String PROP_DeviceInfo_allowNewDevice
See Also:
Constant Field Values

PROP_DeviceInfo_allowDeleteDevice

public static final java.lang.String PROP_DeviceInfo_allowDeleteDevice
See Also:
Constant Field Values

PROP_DeviceInfo_allowEditServerID

public static final java.lang.String PROP_DeviceInfo_allowEditServerID
See Also:
Constant Field Values

PROP_DeviceInfo_allowEditFirmwareVersion

public static final java.lang.String PROP_DeviceInfo_allowEditFirmwareVersion
See Also:
Constant Field Values

PROP_DeviceInfo_showDateCalendar

public static final java.lang.String PROP_DeviceInfo_showDateCalendar
See Also:
Constant Field Values

PROP_DeviceInfo_showNotificationFields

public static final java.lang.String PROP_DeviceInfo_showNotificationFields
See Also:
Constant Field Values

PROP_DeviceInfo_showPropertiesButton

public static final java.lang.String PROP_DeviceInfo_showPropertiesButton
See Also:
Constant Field Values

PROP_DeviceInfo_showSmsButton

public static final java.lang.String PROP_DeviceInfo_showSmsButton
See Also:
Constant Field Values

PROP_DeviceInfo_showNotes

public static final java.lang.String PROP_DeviceInfo_showNotes
See Also:
Constant Field Values

PROP_DeviceInfo_showFixedLocation

public static final java.lang.String PROP_DeviceInfo_showFixedLocation
See Also:
Constant Field Values

PROP_DeviceInfo_showExpectedAcks

public static final java.lang.String PROP_DeviceInfo_showExpectedAcks
See Also:
Constant Field Values

PROP_DeviceInfo_showReportedOdometer

public static final java.lang.String PROP_DeviceInfo_showReportedOdometer
See Also:
Constant Field Values

PROP_DeviceInfo_showReportedEngineHours

public static final java.lang.String PROP_DeviceInfo_showReportedEngineHours
See Also:
Constant Field Values

PROP_DeviceInfo_showMaintenanceOdometer

public static final java.lang.String PROP_DeviceInfo_showMaintenanceOdometer
See Also:
Constant Field Values

PROP_DeviceInfo_showMaintenanceHours

public static final java.lang.String PROP_DeviceInfo_showMaintenanceHours
See Also:
Constant Field Values

PROP_DeviceInfo_showMaintenanceNotes

public static final java.lang.String PROP_DeviceInfo_showMaintenanceNotes
See Also:
Constant Field Values

PROP_DeviceInfo_showReminderMessage

public static final java.lang.String PROP_DeviceInfo_showReminderMessage
See Also:
Constant Field Values

PROP_DeviceInfo_showServiceTime

public static final java.lang.String PROP_DeviceInfo_showServiceTime
See Also:
Constant Field Values

PROP_DeviceInfo_showIgnitionIndex

public static final java.lang.String PROP_DeviceInfo_showIgnitionIndex
See Also:
Constant Field Values

PROP_DeviceInfo_maximumIgnitionIndex

public static final java.lang.String PROP_DeviceInfo_maximumIgnitionIndex
See Also:
Constant Field Values

PROP_DeviceInfo_showInputState_

public static final java.lang.String PROP_DeviceInfo_showInputState_
See Also:
Constant Field Values

PROP_DeviceInfo_showOutputState_

public static final java.lang.String PROP_DeviceInfo_showOutputState_
See Also:
Constant Field Values

PROP_DeviceInfo_showCommandState_

public static final java.lang.String PROP_DeviceInfo_showCommandState_
See Also:
Constant Field Values

PROP_DeviceInfo_showPushpinID

public static final java.lang.String PROP_DeviceInfo_showPushpinID
See Also:
Constant Field Values

PROP_DeviceInfo_showPushpinChooser

public static final java.lang.String PROP_DeviceInfo_showPushpinChooser
See Also:
Constant Field Values

PROP_DeviceInfo_showDisplayColor

public static final java.lang.String PROP_DeviceInfo_showDisplayColor
See Also:
Constant Field Values

PROP_DeviceInfo_showDataKey

public static final java.lang.String PROP_DeviceInfo_showDataKey
See Also:
Constant Field Values

PROP_DeviceInfo_optimizeUpdateDevice

public static final java.lang.String PROP_DeviceInfo_optimizeUpdateDevice
See Also:
Constant Field Values

PROP_DeviceInfo_showDcsPropertiesID

public static final java.lang.String PROP_DeviceInfo_showDcsPropertiesID
See Also:
Constant Field Values

PROP_DeviceInfo_showDcsConfigString

public static final java.lang.String PROP_DeviceInfo_showDcsConfigString
See Also:
Constant Field Values

PROP_DeviceInfo_showPreferredGroupID

public static final java.lang.String PROP_DeviceInfo_showPreferredGroupID
See Also:
Constant Field Values

PROP_DeviceInfo_showAssignedUserID

public static final java.lang.String PROP_DeviceInfo_showAssignedUserID
See Also:
Constant Field Values

PROP_DeviceInfo_showHoursOfOperation

public static final java.lang.String PROP_DeviceInfo_showHoursOfOperation
See Also:
Constant Field Values

PROP_DeviceInfo_showFaultCodes

public static final java.lang.String PROP_DeviceInfo_showFaultCodes
See Also:
Constant Field Values

PROP_DeviceInfo_showFuelCapacity

public static final java.lang.String PROP_DeviceInfo_showFuelCapacity
See Also:
Constant Field Values

PROP_DeviceInfo_showFuelLevelProfile

public static final java.lang.String PROP_DeviceInfo_showFuelLevelProfile
See Also:
Constant Field Values

PROP_DeviceInfo_SMS_useDeviceSMSCommands

public static final java.lang.String PROP_DeviceInfo_SMS_useDeviceSMSCommands
See Also:
Constant Field Values

PROP_DeviceInfo_uniqueSimPhoneNumber

public static final java.lang.String PROP_DeviceInfo_uniqueSimPhoneNumber
See Also:
Constant Field Values

PROP_DeviceInfo_custom_

public static final java.lang.String PROP_DeviceInfo_custom_
See Also:
Constant Field Values

PROP_GroupInfo_showPropertiesButton

public static final java.lang.String PROP_GroupInfo_showPropertiesButton
See Also:
Constant Field Values

PROP_GroupInfo_deviceListSortBy

public static final java.lang.String PROP_GroupInfo_deviceListSortBy
See Also:
Constant Field Values

PROP_TrackMap_calendarAction

public static final java.lang.String PROP_TrackMap_calendarAction
See Also:
Constant Field Values

PROP_TrackMap_calendarDateOnLoad

public static final java.lang.String PROP_TrackMap_calendarDateOnLoad
See Also:
Constant Field Values

PROP_TrackMap_showTimezoneSelection

public static final java.lang.String PROP_TrackMap_showTimezoneSelection
See Also:
Constant Field Values

PROP_TrackMap_mapUpdateOnLoad

public static final java.lang.String PROP_TrackMap_mapUpdateOnLoad
See Also:
Constant Field Values

PROP_TrackMap_autoUpdateRecenter

public static final java.lang.String PROP_TrackMap_autoUpdateRecenter
See Also:
Constant Field Values

PROP_TrackMap_showUpdateAll

public static final java.lang.String PROP_TrackMap_showUpdateAll
See Also:
Constant Field Values

PROP_TrackMap_showUpdateLast

public static final java.lang.String PROP_TrackMap_showUpdateLast
See Also:
Constant Field Values

PROP_TrackMap_showPushpinReplay

public static final java.lang.String PROP_TrackMap_showPushpinReplay
See Also:
Constant Field Values

PROP_TrackMap_showLocationDetails

public static final java.lang.String PROP_TrackMap_showLocationDetails
See Also:
Constant Field Values

PROP_TrackMap_detailAscending

public static final java.lang.String PROP_TrackMap_detailAscending
See Also:
Constant Field Values

PROP_TrackMap_detailCenterPushpin

public static final java.lang.String PROP_TrackMap_detailCenterPushpin
See Also:
Constant Field Values

PROP_TrackMap_includeStatusCodeColor

public static final java.lang.String PROP_TrackMap_includeStatusCodeColor
See Also:
Constant Field Values

PROP_TrackMap_useRouteDisplayColor

public static final java.lang.String PROP_TrackMap_useRouteDisplayColor
See Also:
Constant Field Values

PROP_TrackMap_sortableLocationDetails

public static final java.lang.String PROP_TrackMap_sortableLocationDetails
See Also:
Constant Field Values

PROP_TrackMap_limitType

public static final java.lang.String PROP_TrackMap_limitType
See Also:
Constant Field Values

PROP_TrackMap_fleetDeviceEventCount

public static final java.lang.String PROP_TrackMap_fleetDeviceEventCount
See Also:
Constant Field Values

PROP_TrackMap_showFleetMapDevicePushpin

public static final java.lang.String PROP_TrackMap_showFleetMapDevicePushpin
See Also:
Constant Field Values

PROP_TrackMap_showCursorLocation

public static final java.lang.String PROP_TrackMap_showCursorLocation
See Also:
Constant Field Values

PROP_TrackMap_showDistanceRuler

public static final java.lang.String PROP_TrackMap_showDistanceRuler
See Also:
Constant Field Values

PROP_TrackMap_showLocateNow

public static final java.lang.String PROP_TrackMap_showLocateNow
See Also:
Constant Field Values

PROP_TrackMap_showDeviceLink

public static final java.lang.String PROP_TrackMap_showDeviceLink
See Also:
Constant Field Values

PROP_TrackMap_showLegend

public static final java.lang.String PROP_TrackMap_showLegend
See Also:
Constant Field Values

PROP_TrackMap_pageLinks

public static final java.lang.String PROP_TrackMap_pageLinks
See Also:
Constant Field Values

PROP_TrackMap_showGoogleKML

public static final java.lang.String PROP_TrackMap_showGoogleKML
See Also:
Constant Field Values

PROP_TrackMap_mapControlLocation

public static final java.lang.String PROP_TrackMap_mapControlLocation
See Also:
Constant Field Values

PROP_TrackMap_mapControlCollapsible

public static final java.lang.String PROP_TrackMap_mapControlCollapsible
See Also:
Constant Field Values

PROP_TrackMap_mapControlCollapseOnLoad

public static final java.lang.String PROP_TrackMap_mapControlCollapseOnLoad
See Also:
Constant Field Values

PROP_TrackMap_enableGeocode

public static final java.lang.String PROP_TrackMap_enableGeocode
See Also:
Constant Field Values

PROP_TrackMap_enableGeocode_country

public static final java.lang.String PROP_TrackMap_enableGeocode_country
See Also:
Constant Field Values

PROP_TrackMap_showBatteryLevel

public static final java.lang.String PROP_TrackMap_showBatteryLevel
See Also:
Constant Field Values

PROP_TrackMap_showAllContainedGeozones

public static final java.lang.String PROP_TrackMap_showAllContainedGeozones
See Also:
Constant Field Values

PROP_TrackMap_showNearbyGeozones

public static final java.lang.String PROP_TrackMap_showNearbyGeozones
See Also:
Constant Field Values

PROP_TrackMap_lastDevicePushpin_device

public static final java.lang.String PROP_TrackMap_lastDevicePushpin_device
See Also:
Constant Field Values

PROP_TrackMap_lastDevicePushpin_fleet

public static final java.lang.String PROP_TrackMap_lastDevicePushpin_fleet
See Also:
Constant Field Values

PROP_FullMap_calendarAction

public static final java.lang.String PROP_FullMap_calendarAction
See Also:
Constant Field Values

PROP_FullMap_calendarDateOnLoad

public static final java.lang.String PROP_FullMap_calendarDateOnLoad
See Also:
Constant Field Values

PROP_FullMap_showTimezoneSelection

public static final java.lang.String PROP_FullMap_showTimezoneSelection
See Also:
Constant Field Values

PROP_FullMap_mapUpdateOnLoad

public static final java.lang.String PROP_FullMap_mapUpdateOnLoad
See Also:
Constant Field Values

PROP_FullMap_autoUpdateRecenter

public static final java.lang.String PROP_FullMap_autoUpdateRecenter
See Also:
Constant Field Values

PROP_FullMap_showUpdateAll

public static final java.lang.String PROP_FullMap_showUpdateAll
See Also:
Constant Field Values

PROP_FullMap_showUpdateLast

public static final java.lang.String PROP_FullMap_showUpdateLast
See Also:
Constant Field Values

PROP_FullMap_showPushpinReplay

public static final java.lang.String PROP_FullMap_showPushpinReplay
See Also:
Constant Field Values

PROP_FullMap_detailAscending

public static final java.lang.String PROP_FullMap_detailAscending
See Also:
Constant Field Values

PROP_FullMap_detailCenterPushpin

public static final java.lang.String PROP_FullMap_detailCenterPushpin
See Also:
Constant Field Values

PROP_FullMap_useRouteDisplayColor

public static final java.lang.String PROP_FullMap_useRouteDisplayColor
See Also:
Constant Field Values

PROP_FullMap_limitType

public static final java.lang.String PROP_FullMap_limitType
See Also:
Constant Field Values

PROP_FullMap_fleetDeviceEventCount

public static final java.lang.String PROP_FullMap_fleetDeviceEventCount
See Also:
Constant Field Values

PROP_FullMap_showFleetMapDevicePushpin

public static final java.lang.String PROP_FullMap_showFleetMapDevicePushpin
See Also:
Constant Field Values

PROP_FullMap_showCursorLocation

public static final java.lang.String PROP_FullMap_showCursorLocation
See Also:
Constant Field Values

PROP_FullMap_showDistanceRuler

public static final java.lang.String PROP_FullMap_showDistanceRuler
See Also:
Constant Field Values

PROP_FullMap_showLocateNow

public static final java.lang.String PROP_FullMap_showLocateNow
See Also:
Constant Field Values

PROP_FullMap_showDeviceLink

public static final java.lang.String PROP_FullMap_showDeviceLink
See Also:
Constant Field Values

PROP_FullMap_showLegend

public static final java.lang.String PROP_FullMap_showLegend
See Also:
Constant Field Values

PROP_FullMap_pageLinks

public static final java.lang.String PROP_FullMap_pageLinks
See Also:
Constant Field Values

PROP_FullMap_showGoogleKML

public static final java.lang.String PROP_FullMap_showGoogleKML
See Also:
Constant Field Values

PROP_FullMap_mapControlLocation

public static final java.lang.String PROP_FullMap_mapControlLocation
See Also:
Constant Field Values

PROP_FullMap_mapControlCollapsible

public static final java.lang.String PROP_FullMap_mapControlCollapsible
See Also:
Constant Field Values

PROP_FullMap_enableGeocode

public static final java.lang.String PROP_FullMap_enableGeocode
See Also:
Constant Field Values

PROP_FullMap_enableGeocode_country

public static final java.lang.String PROP_FullMap_enableGeocode_country
See Also:
Constant Field Values

PROP_FullMap_showBatteryLevel

public static final java.lang.String PROP_FullMap_showBatteryLevel
See Also:
Constant Field Values

PROP_FullMap_showAllContainedGeozones

public static final java.lang.String PROP_FullMap_showAllContainedGeozones
See Also:
Constant Field Values

PROP_FullMap_lastDevicePushpin_device

public static final java.lang.String PROP_FullMap_lastDevicePushpin_device
See Also:
Constant Field Values

PROP_FullMap_lastDevicePushpin_fleet

public static final java.lang.String PROP_FullMap_lastDevicePushpin_fleet
See Also:
Constant Field Values

PROP_ReportMenu_useMapDates

public static final java.lang.String PROP_ReportMenu_useMapDates
See Also:
Constant Field Values

PROP_ReportMenu_showTimezoneSelection

public static final java.lang.String PROP_ReportMenu_showTimezoneSelection
See Also:
Constant Field Values

PROP_ReportMenu_enableReportEmail

public static final java.lang.String PROP_ReportMenu_enableReportEmail
See Also:
Constant Field Values

PROP_ReportMenu_enableReportSchedule

public static final java.lang.String PROP_ReportMenu_enableReportSchedule
See Also:
Constant Field Values

PROP_ReportMenu_customFormatURL

public static final java.lang.String PROP_ReportMenu_customFormatURL
See Also:
Constant Field Values

PROP_ReportDisplay_showGoogleKML

public static final java.lang.String PROP_ReportDisplay_showGoogleKML
See Also:
Constant Field Values

PROP_UserInfo_allowDuplicateContactEmail

public static final java.lang.String PROP_UserInfo_allowDuplicateContactEmail
See Also:
Constant Field Values

PROP_UserInfo_showAccessControlList

public static final java.lang.String PROP_UserInfo_showAccessControlList
See Also:
Constant Field Values

PROP_UserInfo_showPreferredDeviceID

public static final java.lang.String PROP_UserInfo_showPreferredDeviceID
See Also:
Constant Field Values

PROP_UserInfo_showAddressFields

public static final java.lang.String PROP_UserInfo_showAddressFields
See Also:
Constant Field Values

PROP_UserInfo_showOfficeLocation

public static final java.lang.String PROP_UserInfo_showOfficeLocation
See Also:
Constant Field Values

PROP_UserInfo_showPassword

public static final java.lang.String PROP_UserInfo_showPassword
See Also:
Constant Field Values

PROP_UserInfo_authorizedGroupCount

public static final java.lang.String PROP_UserInfo_authorizedGroupCount
See Also:
Constant Field Values

PROP_UserInfo_showNotes

public static final java.lang.String PROP_UserInfo_showNotes
See Also:
Constant Field Values

PROP_UserInfo_custom_

public static final java.lang.String PROP_UserInfo_custom_
See Also:
Constant Field Values

PROP_ZoneInfo_mapControlLocation

public static final java.lang.String PROP_ZoneInfo_mapControlLocation
See Also:
Constant Field Values

PROP_ZoneInfo_enableGeocode

public static final java.lang.String PROP_ZoneInfo_enableGeocode
See Also:
Constant Field Values

PROP_ZoneInfo_enableGeocode_country

public static final java.lang.String PROP_ZoneInfo_enableGeocode_country
See Also:
Constant Field Values

PROP_ZoneInfo_showOverlapPriority

public static final java.lang.String PROP_ZoneInfo_showOverlapPriority
See Also:
Constant Field Values

PROP_ZoneInfo_showReverseGeocodeZone

public static final java.lang.String PROP_ZoneInfo_showReverseGeocodeZone
See Also:
Constant Field Values

PROP_ZoneInfo_showArriveDepartZone

public static final java.lang.String PROP_ZoneInfo_showArriveDepartZone
See Also:
Constant Field Values

PROP_ZoneInfo_showArriveDepartCode

public static final java.lang.String PROP_ZoneInfo_showArriveDepartCode
See Also:
Constant Field Values

PROP_ZoneInfo_showAssignedDeviceGroup

public static final java.lang.String PROP_ZoneInfo_showAssignedDeviceGroup
See Also:
Constant Field Values

PROP_ZoneInfo_showAutoNotify

public static final java.lang.String PROP_ZoneInfo_showAutoNotify
See Also:
Constant Field Values

PROP_ZoneInfo_showClientUploadZone

public static final java.lang.String PROP_ZoneInfo_showClientUploadZone
See Also:
Constant Field Values

PROP_ZoneInfo_showShapeColor

public static final java.lang.String PROP_ZoneInfo_showShapeColor
See Also:
Constant Field Values

PROP_ZoneInfo_showPushpins

public static final java.lang.String PROP_ZoneInfo_showPushpins
See Also:
Constant Field Values

PROP_ZoneInfo_showSpeedLimit

public static final java.lang.String PROP_ZoneInfo_showSpeedLimit
See Also:
Constant Field Values

PROP_ZoneInfo_showCorridorID

public static final java.lang.String PROP_ZoneInfo_showCorridorID
See Also:
Constant Field Values

PROP_ZoneInfo_showPurposeID

public static final java.lang.String PROP_ZoneInfo_showPurposeID
See Also:
Constant Field Values

PROP_ZoneInfo_zonePurposeList

public static final java.lang.String PROP_ZoneInfo_zonePurposeList
See Also:
Constant Field Values

PROP_ZoneInfo_maximumDisplayedVertices

public static final java.lang.String PROP_ZoneInfo_maximumDisplayedVertices
See Also:
Constant Field Values

PROP_CorridorInfo_mapControlLocation

public static final java.lang.String PROP_CorridorInfo_mapControlLocation
See Also:
Constant Field Values

PROP_CorridorInfo_showShapeColor

public static final java.lang.String PROP_CorridorInfo_showShapeColor
See Also:
Constant Field Values

PROP_CorridorInfo_enableGeocode

public static final java.lang.String PROP_CorridorInfo_enableGeocode
See Also:
Constant Field Values

PROP_CorridorInfo_enableGeocode_country

public static final java.lang.String PROP_CorridorInfo_enableGeocode_country
See Also:
Constant Field Values

PROP_CorridorInfo_pointCount

public static final java.lang.String PROP_CorridorInfo_pointCount
See Also:
Constant Field Values

PROP_RuleInfo_showEMailWrapper

public static final java.lang.String PROP_RuleInfo_showEMailWrapper
See Also:
Constant Field Values

PROP_RuleInfo_showSysRulesOnly

public static final java.lang.String PROP_RuleInfo_showSysRulesOnly
See Also:
Constant Field Values

PROP_RuleInfo_showSysRules

public static final java.lang.String PROP_RuleInfo_showSysRules
See Also:
Constant Field Values

PROP_RuleInfo_showCronRules

public static final java.lang.String PROP_RuleInfo_showCronRules
See Also:
Constant Field Values

PROP_RuleInfo_ruleTagList

public static final java.lang.String PROP_RuleInfo_ruleTagList
See Also:
Constant Field Values

PROP_RuleInfo_showTriggerActions

public static final java.lang.String PROP_RuleInfo_showTriggerActions
See Also:
Constant Field Values

PROP_RuleInfo_showPredefinedActions

public static final java.lang.String PROP_RuleInfo_showPredefinedActions
See Also:
Constant Field Values

PROP_DeviceChooser_sortBy

public static final java.lang.String PROP_DeviceChooser_sortBy
See Also:
Constant Field Values

PROP_DeviceChooser_useTable

public static final java.lang.String PROP_DeviceChooser_useTable
See Also:
Constant Field Values

PROP_DeviceChooser_idPosition

public static final java.lang.String PROP_DeviceChooser_idPosition
See Also:
Constant Field Values

PROP_DeviceChooser_search

public static final java.lang.String PROP_DeviceChooser_search
See Also:
Constant Field Values

PROP_DeviceChooser_matchContains

public static final java.lang.String PROP_DeviceChooser_matchContains
See Also:
Constant Field Values

PROP_DeviceChooser_singleItemTextField

public static final java.lang.String PROP_DeviceChooser_singleItemTextField
See Also:
Constant Field Values

PROP_DeviceChooser_includeListHtml

public static final java.lang.String PROP_DeviceChooser_includeListHtml
See Also:
Constant Field Values

PROP_DeviceChooser_extraDebugEntries

public static final java.lang.String PROP_DeviceChooser_extraDebugEntries
See Also:
Constant Field Values

PROP_WorkZoneInfo_mapControlLocation

public static final java.lang.String PROP_WorkZoneInfo_mapControlLocation
See Also:
Constant Field Values

PROP_StatusCodeInfo_showIconSelector

public static final java.lang.String PROP_StatusCodeInfo_showIconSelector
See Also:
Constant Field Values

PROP_StatusCodeInfo_showPushpinChooser

public static final java.lang.String PROP_StatusCodeInfo_showPushpinChooser
See Also:
Constant Field Values

PROP_DeviceAlerts_refreshInterval

public static final java.lang.String PROP_DeviceAlerts_refreshInterval
See Also:
Constant Field Values

PROP_DeviceAlerts_mapPageName

public static final java.lang.String PROP_DeviceAlerts_mapPageName
See Also:
Constant Field Values

PROP_DeviceAlerts_showAllDevices

public static final java.lang.String PROP_DeviceAlerts_showAllDevices
See Also:
Constant Field Values

PROP_DeviceAlerts_maxActiveAlertAge

public static final java.lang.String PROP_DeviceAlerts_maxActiveAlertAge
See Also:
Constant Field Values

PROP_EntityAdmin_entityType

public static final java.lang.String PROP_EntityAdmin_entityType
See Also:
Constant Field Values

PROP_SysAdminAccounts_allowDeleteAccount

public static final java.lang.String PROP_SysAdminAccounts_allowDeleteAccount
See Also:
Constant Field Values

PROP_SysAdminAccounts_showPasswords

public static final java.lang.String PROP_SysAdminAccounts_showPasswords
See Also:
Constant Field Values

PROP_SysAdminAccounts_accountProperties

public static final java.lang.String PROP_SysAdminAccounts_accountProperties
See Also:
Constant Field Values

PROP_SysAdminAccounts_showAccountManager

public static final java.lang.String PROP_SysAdminAccounts_showAccountManager
See Also:
Constant Field Values

PROP_SysAdminAccounts_showRetainEvents

public static final java.lang.String PROP_SysAdminAccounts_showRetainEvents
See Also:
Constant Field Values

PROP_SysAdminAccounts_showAllowWebService

public static final java.lang.String PROP_SysAdminAccounts_showAllowWebService
See Also:
Constant Field Values

PROP_SysAdminAccounts_showAutoAddDevices

public static final java.lang.String PROP_SysAdminAccounts_showAutoAddDevices
See Also:
Constant Field Values

PROP_SysAdminAccounts_showDataPushURL

public static final java.lang.String PROP_SysAdminAccounts_showDataPushURL
See Also:
Constant Field Values

PROP_SysAdminAccounts_showNotes

public static final java.lang.String PROP_SysAdminAccounts_showNotes
See Also:
Constant Field Values

PROP_SysAccountsLogin_enableLogin

public static final java.lang.String PROP_SysAccountsLogin_enableLogin
See Also:
Constant Field Values

PROP_SysAccountsLogin_passcode

public static final java.lang.String PROP_SysAccountsLogin_passcode
See Also:
Constant Field Values

PROP_SysAccountsLogin_enableReturn

public static final java.lang.String PROP_SysAccountsLogin_enableReturn
See Also:
Constant Field Values

PROP_SysAccountsLogin_enableReturn_timeout

public static final java.lang.String PROP_SysAccountsLogin_enableReturn_timeout
See Also:
Constant Field Values

PROP_SysAdminInfo_showEventCount

public static final java.lang.String PROP_SysAdminInfo_showEventCount
See Also:
Constant Field Values

PROP_SysAdminInfo_showEventsPerSecond

public static final java.lang.String PROP_SysAdminInfo_showEventsPerSecond
See Also:
Constant Field Values

PROP_Calendar_firstDayOfWeek

public static final java.lang.String PROP_Calendar_firstDayOfWeek
See Also:
Constant Field Values

PROP_Calendar_timeTextField

public static final java.lang.String PROP_Calendar_timeTextField
See Also:
Constant Field Values

PROP_Banner_width

public static final java.lang.String PROP_Banner_width
See Also:
Constant Field Values

PROP_Banner_style

public static final java.lang.String PROP_Banner_style
See Also:
Constant Field Values

PROP_Banner_imageSource

public static final java.lang.String PROP_Banner_imageSource
See Also:
Constant Field Values

PROP_Banner_imageWidth

public static final java.lang.String PROP_Banner_imageWidth
See Also:
Constant Field Values

PROP_Banner_imageHeight

public static final java.lang.String PROP_Banner_imageHeight
See Also:
Constant Field Values

PROP_Banner_imageLink

public static final java.lang.String PROP_Banner_imageLink
See Also:
Constant Field Values

_isTrackServlet

protected static boolean _isTrackServlet

RGNAME_ACTIVE

public static java.lang.String RGNAME_ACTIVE
Constructor Detail

BasicPrivateLabel

protected BasicPrivateLabel()
Constructor


BasicPrivateLabel

public BasicPrivateLabel(java.lang.String host)
Constructor

Parameters:
host - The primary host name associated with this BasicPrivateLabel
Method Detail

setTrackServlet_loaderOnly

public static void setTrackServlet_loaderOnly()

isTrackServlet

public static boolean isTrackServlet()

postInitialization

public void postInitialization()
Callback after load initialization


setDefaultBaseURL

public void setDefaultBaseURL(java.lang.String baseURL)
Sets the default BaseURL (ie. "http://localhost:8080/track/Track")

Parameters:
baseURL - The base URL

hasDefaultBaseURL

public boolean hasDefaultBaseURL()
Returns true if a base URL has been defined

Returns:
True if a base URL has been defined

getDefaultBaseURL

public java.lang.String getDefaultBaseURL()
Gets the default BaseURL (or null if no base URL is defined)

Returns:
The default BaseURL

toString

public java.lang.String toString()
Return String representation of this instance

Overrides:
toString in class java.lang.Object
Returns:
String representation of this instance

setHostName

public void setHostName(java.lang.String host)
Sets the primary host name associated with this BasicPrivateLabel

Parameters:
host - The primary host name to associate with this BasicPrivateLabel

getHostName

public java.lang.String getHostName()
Gets the primary host name associated with this BasicPrivateLabel

Returns:
The primary host name associated with this BasicPrivateLabel

addHostAlias

public void addHostAlias(java.lang.String host,
                         java.lang.String desc)
Adds a host alias to this BasicPrivateLabel

Parameters:
host - The host alias to add
desc - The host alias description (currently not used)

getHostAliasNames

public java.util.List<java.lang.String> getHostAliasNames()
Gets the list of host name aliases

Returns:
The list of host nmae aliases

setDomainName

public void setDomainName(java.lang.String name)
Sets the host alias name

Parameters:
name - The host alias name

getDomainName

public java.lang.String getDomainName()
Gets the host alias name

Returns:
The host alias name

getName

public java.lang.String getName()
Gets the name of this BasicPrivateLabel.

Returns:
If specified, the alias name will be returned, otherwise the host name will be reutrned

setAccountLogin

public void setAccountLogin(boolean acctLogin)
Sets the account login display state

Parameters:
acctLogin - True to display account login, false otherwise

getAccountLogin

public boolean getAccountLogin()
Gets the account login display state

Returns:
True to display the account login, false to hide account login (if implemented)

setUserLogin

public void setUserLogin(boolean userLogin)
Sets the user login display state

Parameters:
userLogin - True to display user login, false otherwise

getUserLogin

public boolean getUserLogin()
Gets the user login display state

Returns:
True to display the user login, false to hide user login

setAllowEmailLogin

public void setAllowEmailLogin(boolean emailLogin)
Sets the Enabled/Disabled contact-email login state

Parameters:
emailLogin - True to enable contact-email login

getAllowEmailLogin

public boolean getAllowEmailLogin()
Gets the Enabled/Disabled contact-email login state

Returns:
True if contact-email login is enabled

setDefaultLoginAccount

public void setDefaultLoginAccount(java.lang.String defaultAccount)
Sets the default login account name

Parameters:
defaultAccount - The default login account

getDefaultLoginAccount

public java.lang.String getDefaultLoginAccount()
Gets the default login account name

Returns:
The default login account name

setDefaultLoginUser

public void setDefaultLoginUser(java.lang.String defaultUser)
Sets the default login user name

Parameters:
defaultUser - The default login user

getDefaultLoginUser

public java.lang.String getDefaultLoginUser()
Gets the default login user name

Returns:
The default login user name

setPasswordHandler

public void setPasswordHandler(PasswordHandler pwh)
Sets the PasswordHandler for this Domain

Parameters:
pwh - The PasswordHandler for the Domain

getPasswordHandler

public PasswordHandler getPasswordHandler()
Gets the PasswordHandler for this Domain

Returns:
The PasswordHandler for the Domain

HasSupportedLocalesMap

public static boolean HasSupportedLocalesMap()
Returns true if a set of supported Locales is defined


SetSupportedLocalesMap

public static void SetSupportedLocalesMap(OrderedMap<java.lang.String,I18N.Text> localeMap)
Sets the supported Locales

Parameters:
localeMap - The supported Locale map

GetSupportedLocaleMap

public static java.util.Map<java.lang.String,java.lang.String> GetSupportedLocaleMap(java.util.Locale locale)
Gets a map of supported locales

Parameters:
locale - The preferred Locale
Returns:
The Supported Locale map

setLocaleString

public void setLocaleString(java.lang.String localeStr)
Sets the locale String code for this BasicPrivateLabel

Parameters:
localeStr - The locale String associated with this BasicPrivateLabel

getLocaleString

public java.lang.String getLocaleString()
Gets the locale String code for this BasicPrivateLabel

Returns:
The locale String code for this BasicPrivateLabel

getLocale

public java.util.Locale getLocale()
Gets the Locale for the current locale String code

Returns:
The Locale associated with this BasicPrivateLabel

getI18N

public I18N getI18N(java.lang.Class clazz)
Gets the I18N instance for the specified class using the Locale associated with this BasicPrivateLabel

Parameters:
clazz - The class for which the I18N instance will be returned
Returns:
The I18N instance for the specified class

getI18N

public I18N getI18N(java.lang.Package pkg)
Gets the I18N instance for the specified package using the Locale associated with this BasicPrivateLabel

Parameters:
pkg - The package for which the I18N instance will be returned
Returns:
The I18N instance for the specified package

setDateFormat

public void setDateFormat(java.lang.String dateFmt)
Sets the date format for the current BasicPrivateLabel

Parameters:
dateFmt - The date format

getDateFormat

public java.lang.String getDateFormat()
Gets the date format for this BasicPrivateLabel

Returns:
The date format

getDateStringFormat

public DateTime.DateStringFormat getDateStringFormat()
Gets the DateStringFormat enumerated type

Returns:
The DateStringFormat enumerated type

getDateStringFormat

public DateTime.DateStringFormat getDateStringFormat(java.lang.String dateFormat)
Gets the DateStringFormat enumerated type

Returns:
The DateStringFormat enumerated type (not null)

isDateFormatYMD

public boolean isDateFormatYMD()
Return true if date format is YMD, false otherwise

Returns:
True if date format is YMD

isDateFormatMDY

public boolean isDateFormatMDY()
Return true if date format is MDY, false otherwise

Returns:
True if date format is MDY

isDateFormatDMY

public boolean isDateFormatDMY()
Return true if date format is DMY, false otherwise

Returns:
True if date format is DMY

getDateStringFormatText

public java.lang.String getDateStringFormatText(java.util.Locale locale)
Gets the DateStringFormat enumerated type

Returns:
The DateStringFormat enumerated type

getDefaultDateFormat

public static java.lang.String getDefaultDateFormat()
Gets the default date format

Returns:
The default date format

setTimeFormat

public void setTimeFormat(java.lang.String timeFmt)
Sets the time format for this BasicPrivateLabel

Parameters:
timeFmt - The time format

getTimeFormat

public java.lang.String getTimeFormat()
Gets the time format for this BasicPrivateLabel

Returns:
The time format

getDefaultTimeFormat

public static java.lang.String getDefaultTimeFormat()
Gets the default time format

Returns:
The default time format

setRestricted

public void setRestricted(boolean restricted)
Sets the 'restricted mode' for this BasicPrivateLabel. This means that only Account that reference this particular BasicPrivalLable name have access to the resources defined by this BasicPrivateLabel.

Parameters:
restricted - True to enforce restricted access, false otherwise

isRestricted

public boolean isRestricted()
Returns true this is BasicPrivateLabel has restricted access

Returns:
True if this BasicPrivateLabel has restricted access

setShowPassword

public void setShowPassword(boolean showPass)
Sets whether to show the password, or not

Parameters:
showPass - True to show password, false to hide the password field.

getShowPassword

public boolean getShowPassword()
Returns true if the password field is to be made visible

Returns:
True if the password field is to be made visible, false otherwise

setEnableDemo

public void setEnableDemo(boolean isDemo)
Sets the 'demo' mode for this BasicPrivateLabel

Parameters:
isDemo - True to enable 'demo' support, false to disable.

getEnableDemo

public boolean getEnableDemo()
Returns true if this BasicPrivateLabel supports a 'demo' mode

Returns:
True if 'demo' mode is supported, false otherwise

clearTimeZones

public void clearTimeZones()
Clears TimeZone cache


setTimeZones

public void setTimeZones(OrderedSet<java.lang.String> tmz)
Sets the TimeZones supported by this BasicPrivateLabel

Parameters:
tmz - The list of supported TimeZones

setTimeZones

public void setTimeZones(java.util.List<java.lang.String> tmz)
Sets the TimeZones supported by this BasicPrivateLabel

Parameters:
tmz - The list of supported TimeZones

setTimeZones

public void setTimeZones(java.lang.String[] tmz)
Sets the TimeZones supported by this BasicPrivateLabel

Parameters:
tmz - The array of supported TimeZones

getTimeZonesList

public java.util.List<java.lang.String> getTimeZonesList()
Gets the list of supported TimeZones

Returns:
The list of supported TimeZones

getTimeZonesArray

public java.lang.String[] getTimeZonesArray()
Gets the list of supported TimeZones

Returns:
The list of supported TimeZones

getTimeZones

public java.lang.String[] getTimeZones()
Gets an array of supported TimeZones

Returns:
The array of supported TimeZones

getAllTimeZones

public static java.lang.String[] getAllTimeZones()
Returns an array of all possible TimeZone names

Returns:
An array of all possible TimeZone names

setPageTitle

public void setPageTitle(I18N.Text text)
Sets the title used on HTML pages displayed for this BasicPrivateLabel

Parameters:
text - The title of the HTML page

setPageTitle

public void setPageTitle(java.lang.String text)
Sets the title used on HTML pages displayed for this BasicPrivateLabel

Parameters:
text - The title of the HTML page

getPageTitle

public java.lang.String getPageTitle()
Gets the HTML page title for this BasicPrivateLabel

Returns:
The HTML page title

addReverseGeocodeProvider

public void addReverseGeocodeProvider(ReverseGeocodeProvider rgp,
                                      boolean active)
Sets the ReverseGeocodeProvider for this BasicPrivateLabel

Parameters:
rgp - The ReverseGeocodeProvider

getReverseGeocodeProvider

public ReverseGeocodeProvider getReverseGeocodeProvider()
Returns the active ReverseGeocodeProvider for this BasicPrivatelabel

Returns:
The active ReverseGeocodeProvider for this BasicPrivatelabel

getReverseGeocodeProvider

public ReverseGeocodeProvider getReverseGeocodeProvider(java.lang.String name)
Returns the named ReverseGeocodeProvider for this BasicPrivatelabel

Parameters:
name - The named ReverseGeocodeProvider to return
Returns:
The named ReverseGeocodeProvider for this BasicPrivatelabel

addGeocodeProvider

public void addGeocodeProvider(GeocodeProvider gp,
                               boolean active)
Sets the GeocodeProvider for this BasicPrivateLabel

Parameters:
gp - The GeocodeProvider

getGeocodeProvider

public GeocodeProvider getGeocodeProvider()
Returns the active GeocodeProvider for this BasicPrivatelabel

Returns:
The active GeocodeProvider for this BasicPrivatelabel

getGeocodeProvider

public GeocodeProvider getGeocodeProvider(java.lang.String name)
Returns the named GeocodeProvider for this BasicPrivatelabel

Parameters:
name - The named GeocodeProvider to return
Returns:
The named GeocodeProvider for this BasicPrivatelabel

addMobileLocationProvider

public void addMobileLocationProvider(org.opengts.cellid.MobileLocationProvider mp)
Sets the MobileLocationProvider for this BasicPrivateLabel

Parameters:
mp - The MobileLocationProvider

getMobileLocationProvider

public org.opengts.cellid.MobileLocationProvider getMobileLocationProvider()
Returns the active MobileLocationProvider for this BasicPrivatelabel

Returns:
The active MobileLocationProvider for this BasicPrivatelabel

getMobileLocationProvider

public org.opengts.cellid.MobileLocationProvider getMobileLocationProvider(java.lang.String name)
Returns the named MobileLocationProvider for this BasicPrivatelabel

Parameters:
name - The named MobileLocationProvider to return
Returns:
The named MobileLocationProvider for this BasicPrivatelabel

getPushpinIconIndex

public int getPushpinIconIndex(java.lang.String pushpinID,
                               int dftIndex)
Return the MapProvider's Pushpin index for the specified pushpin ID

Parameters:
pushpinID - The pushpin ID
dftIndex - The default index value (0..9 are always defined)
Returns:
The pushpin icon index

getPushpinIconIndex

public int getPushpinIconIndex(java.lang.String mapProviderID,
                               java.lang.String pushpinID,
                               int dftIndex)
Return the MapProvider's Pushpin index for the specified pushpin ID

Parameters:
mapProviderID - The MapProvider ID (may be null)
pushpinID - The pushpin ID
dftIndex - The default index value (0..9 are always defined)
Returns:
The pushpin icon index

setCopyright

public void setCopyright(java.lang.String copyright)
Sets the copyright notice for this BasicPrivateLabel

Parameters:
copyright - The copyright notice

getCopyright

public java.lang.String getCopyright()
Gets the copyright notice for this BasicPrivateLabel

Returns:
The copyright notice

addAclMap

public void addAclMap(AclEntry.AccessLevel dftAccess,
                      java.util.Map<java.lang.String,AclEntry> aclMap)
Sets the user Access-Control for this BasicPrivateLabel

Parameters:
dftAccess - The defalt access level
aclMap - The access-control map

getMaximumAccessLevel

public AclEntry.AccessLevel getMaximumAccessLevel(java.lang.String aclName)
Gets the maximum access-control level for this BasicPrivateLabel

Returns:
The maximum acces-control level

getDefaultAccessLevel

public AclEntry.AccessLevel getDefaultAccessLevel()
Gets the global default access-control level for this BasicPrivateLabel

Returns:
The default access-control level (does not reutrn null)

getDefaultAccessLevel

public AclEntry.AccessLevel getDefaultAccessLevel(java.lang.String aclName)
Gets the default access-control level for this BasicPrivateLabel

Parameters:
aclName - The ACL key
Returns:
The default acces-control level (does not reutrn null)

getAclEntry

public AclEntry getAclEntry(java.lang.String aclName)
Returns the AclEntry for the specified key

Returns:
The AclEntry, or null if the key does not exist

removeAclEntry

public AclEntry removeAclEntry(java.lang.String aclName)
Removes the AclEntry for the specified key

Returns:
The removed AclEntry, or null if the key does not exist

hasAclEntry

public boolean hasAclEntry(java.lang.String aclName)
Returns true if the AclEntry key is defined

Returns:
True if the AclEntry key is defined

getAllAclEntries

public AclEntry[] getAllAclEntries()
Returns all defined AclEntries

Returns:
An array of AclEntry items

getAccessLevel

public AclEntry.AccessLevel getAccessLevel(Role role,
                                           java.lang.String aclName)
Returns the AccessLevel for the specified ACL key

Parameters:
role - The Role
aclName - The ACL key
Returns:
The AccessLevel for the specified ACL key

getAccessLevel

public AclEntry.AccessLevel getAccessLevel(User user,
                                           java.lang.String aclName)
Returns true is user has 'ALL' access rights for the specified ACL key

Parameters:
user - The User
aclName - The ACL key
Returns:
True is user has 'ALL' access rights for the specified ACL key

hasAllAccess

public boolean hasAllAccess(User user,
                            java.lang.String aclName)
Returns true is user has 'ALL' access rights for the specified ACL key

Parameters:
user - The User
aclName - The ACL key
Returns:
True is user has 'ALL' access rights for the specified ACL key

hasWriteAccess

public boolean hasWriteAccess(User user,
                              java.lang.String aclName)
Returns true is user has 'WRITE' access rights for the specified ACL key

Parameters:
user - The User
aclName - The ACL key
Returns:
True is user has 'WRITE' access rights for the specified ACL key

hasReadAccess

public boolean hasReadAccess(User user,
                             java.lang.String aclName)
Returns true is user has 'READ' access rights for the specified ACL key

Parameters:
user - The User
aclName - The ACL key
Returns:
True is user has 'READ' access rights for the specified ACL key

setEventNotificationEMail

public void setEventNotificationEMail(java.lang.String emailFrom,
                                      I18N.Text emailSubj,
                                      I18N.Text emailBody,
                                      boolean useAsDefault)
Sets the event notification Email attributes

Parameters:
emailFrom - The EMail 'From' address
emailSubj - The EMail 'Subject'
emailBody - The EMail 'Body'
useAsDefault - True to use this subj/body as the default entry for Rule notifications

getEventNotificationFrom

public java.lang.String getEventNotificationFrom()
Gets the EMail notification 'From' address

Returns:
The Email notification 'From' address

hasEventNotificationEMail

public boolean hasEventNotificationEMail()
Return true if the notification subject and/or message is defined

Returns:
True if the notification subject and/or message is defined

getEventNotificationSubject

public java.lang.String getEventNotificationSubject()
Gets the EMail notification 'Subject'

Returns:
The Email notification 'Subject'

getEventNotificationBody

public java.lang.String getEventNotificationBody()
Gets the EMail notification message 'Body'

Returns:
The Email notification message 'Body'

getEventNotificationDefault

public boolean getEventNotificationDefault()
Returns true if the email notification subject/body is to be used as the default entry for new created Rule definitions.

Returns:
True if the event notification subject/body is to be used as the default.

setEMailAddress

public void setEMailAddress(java.lang.String type,
                            java.lang.String emailAddr)
Sets the default EMail 'From' addresses

Parameters:
type - The 'type' of default EMail address
emailAddr - The EMail address

getEMailAddress

public java.lang.String getEMailAddress(java.lang.String type)
Gets the 'From' EMail address for the specified type

Parameters:
type - The 'type' of EMail address to return
Returns:
The 'From' EMail address for the specified type

getEMailAddresses

public java.lang.String[] getEMailAddresses()
Returns an array of all defined EMail addresses (used by CHeckInstall)

Returns:
An array of defined EMail addresses

setSmtpProperties

public void setSmtpProperties(SendMail.SmtpProperties smtpProps)
Set SMTP server properties


getSmtpProperties

public SendMail.SmtpProperties getSmtpProperties()
Get SMTP server properties


globalValidateIDs

public boolean globalValidateIDs()
Returns true if all IDs should be validated for proper characters


globalEditAfterNew

public boolean globalEditAfterNew()
Returns true if all IDs should be validated for proper characters


setRTProperties

public void setRTProperties(RTProperties rtp)
Sets (appends) the the specified properties to this BasicPrivateLabel


getRTProperties

public RTProperties getRTProperties()
Gets the properties of this BasicPrivateLabel


pushRTProperties

public void pushRTProperties()
Pushes the properties of this BasicPrivateLabel on the temporary RTConfig properties stack


popRTProperties

public void popRTProperties()
Pops the properties of this BasicPrivateLabel from the temporary RTConfig properties stack


printProperties

public void printProperties()
Prints the current properties to stdout


printProperties

public void printProperties(java.lang.String msg)
Prints the current properties to stdout


setProperty

public void setProperty(java.lang.Object key,
                        java.lang.Object value)
Sets the property value for the specified key

Specified by:
setProperty in interface RTConfig.PropertySetter
Parameters:
key - The property key
value - The property value

setStringProperty

public void setStringProperty(java.lang.String key,
                              java.lang.String value)
Sets the property String value for the specified key

Parameters:
key - The property key
value - The property String value

setI18NTextProperty

public void setI18NTextProperty(java.lang.String key,
                                I18N.Text value)
Sets the property I18N value for the specified key

Parameters:
key - The property key
value - The property I18N value

getProperty

public java.lang.Object getProperty(java.lang.String key)
Gets the property value for the specified key

Parameters:
key - The property key
Returns:
The property value

getPropertyKeys

public java.util.Collection<java.lang.String> getPropertyKeys(java.lang.String keyPrefix)
Gets the property keys matching the specified key prefix

Parameters:
keyPrefix - The property key prefix
Returns:
A collection of property keys (a show copy)

hasProperty

public boolean hasProperty(java.lang.String key)
Returns true if the property key is defined by thie BasicPrivateLabel

Parameters:
key - The property key
Returns:
True if the specified property key is defined by this BasicPrivateLabel

getStringProperty

public java.lang.String getStringProperty(java.lang.String key,
                                          java.lang.String dft)
Gets the String property value for the specified key

Parameters:
key - The property key
dft - The default value returned if the property key is not defined
Returns:
The property String value

getI18NTextString

public java.lang.String getI18NTextString(java.lang.String key,
                                          java.lang.String dft)
Gets the Localized text for the specified String key

Returns:
The HTML page title

getDoubleProperty

public double getDoubleProperty(java.lang.String key,
                                double dft)
Gets the double property value for the specified key

Parameters:
key - The property key
dft - The default value returned if the property key is not defined
Returns:
The property double value

getLongProperty

public long getLongProperty(java.lang.String key,
                            long dft)
Gets the long property value for the specified key

Parameters:
key - The property key
dft - The default value returned if the property key is not defined
Returns:
The property long value

getIntProperty

public int getIntProperty(java.lang.String key,
                          int dft)
Gets the int property value for the specified key

Parameters:
key - The property key
dft - The default value returned if the property key is not defined
Returns:
The property int value

getBooleanProperty

public boolean getBooleanProperty(java.lang.String key,
                                  boolean dft)
Gets the boolean property value for the specified key

Parameters:
key - The property key
dft - The default value returned if the property key is not defined
Returns:
The property boolean value

setStatusCodeOnly

public void setStatusCodeOnly(boolean only)
Sets the exclusive status codes state

Parameters:
only - If true, only status codes set by this PrivateLabel will be visible

getStatusCodeOnly

public boolean getStatusCodeOnly()
Gets the exclusive status codes state

Returns:
True if only status codes set by this PrivateLabel will be visible

addStatusCode

public void addStatusCode(StatusCodes.Code code)
Adds a customized status code description override

Parameters:
code - The StatusCode to add

getCustomStatusCodeMap

public java.util.Map<java.lang.Integer,StatusCodes.Code> getCustomStatusCodeMap()
Returns a Map of custom status codes

Returns:
A Map of custom status codes (or null if there are no custom status codes)

getStatusCodeDescriptionMap

public OrderedMap<java.lang.Integer,java.lang.String> getStatusCodeDescriptionMap()
Returns a Map of StatusCodes to their desriptions

Returns:
a Map of StatusCodes to their desriptions

getStatusCodeList

public OrderedSet<java.lang.Integer> getStatusCodeList()
Returns a Set of StatusCodes

Returns:
a Set of StatusCodes

getStatusCode

public StatusCodes.Code getStatusCode(java.lang.Integer code)
Return specific code (from statusCode)

Parameters:
code - The status code
Returns:
The StatusCode.Code instance

getStatusCode

public StatusCodes.Code getStatusCode(int code)
Return specific code (from statusCode)

Parameters:
code - The status code
Returns:
The StatusCode.Code instance

setPredefinedRulesActions

public void setPredefinedRulesActions(PredefinedRuleAction[] predefRuleAct)
Sets the list of PredefinedRuleActions

Parameters:
predefRuleAct - The list of predefined rule actions

getPredefinedRuleActions

public PredefinedRuleAction[] getPredefinedRuleActions()
Gets the list of PredefinedRuleActions

Returns:
The list of predefined rule actions

getPointsOfInterest

public java.util.List<PoiProvider> getPointsOfInterest()
Gets the global PointsOfInterest (overridden)

Returns:
The PointsOfInterest list

isSystemAccountsLoginEnabled

public boolean isSystemAccountsLoginEnabled(java.lang.String acctID)
Returns true if SystemAccountsLogin is enabled

Returns:
True if SystemAccountsLogin is enabled, false otherwise

getSystemAccountsLoginPasscode

public java.lang.String getSystemAccountsLoginPasscode(java.lang.String acctID)
Gets the SystemAccountsLogin passcode

Returns:
The SystemAccountsLogin passcode

isSystemAccountsLoginReturnEnabled

public boolean isSystemAccountsLoginReturnEnabled(java.lang.String acctID)
Returns true if SystemAccountsLogin Return is enabled

Returns:
True if SystemAccountsLogin Return is enabled, false otherwise

getSystemAccountsLoginReturnTimeout

public long getSystemAccountsLoginReturnTimeout(java.lang.String acctID)
Gets the SystemAccountsLogin timeout (in seconds)

Returns:
The SystemAccountsLogin timeout in seconds.