org.opengts.war.tools
Class PrivateLabel

java.lang.Object
  org.opengts.db.BasicPrivateLabel
      org.opengts.war.tools.PrivateLabel

All Implemented Interfaces:

RTConfig.PropertySetter

public class PrivateLabel
extends BasicPrivateLabel

Nested Class Summary

static class

PrivateLabel.JSPEntry

Field Summary

static java.lang.String	CONTEXT_FILE_OFFLINE
static java.lang.String	DEFAULT_CSS_DIR
static java.lang.String	JSPENTRY_DEFAULT

Fields inherited from class org.opengts.db.BasicPrivateLabel

_isTrackServlet, ALL_HOSTS, DEFAULT_HOST, EMAIL_TYPE_ACCOUNTS, EMAIL_TYPE_COMMAND, EMAIL_TYPE_DEFAULT, EMAIL_TYPE_NOTIFY, EMAIL_TYPE_PASSWORD, EMAIL_TYPE_SUPPORT, LAF_Background_Color, LAF_Background_Image, LAF_Background_Position, LAF_Background_Repeat, LAF_Banner_AnchorLink, LAF_Banner_ImageHeight, LAF_Banner_ImageSource, LAF_Banner_ImageWidth, LAF_Banner_Style, LAF_Banner_Width, LAF_ContentCell_Color, LAF_Copyright, LAF_IconMenu_GroupTitle_Color, LAF_JSPEntry_, LAF_JSPEntry_Default, LAF_PageTitle, PROP_AccountLogin_legacyLAF, PROP_AccountLogin_showLocaleSelection, PROP_AccountLogin_showLoginLink, PROP_Banner_imageHeight, PROP_Banner_imageLink, PROP_Banner_imageSource, PROP_Banner_imageWidth, PROP_Banner_style, PROP_Banner_width, PROP_Calendar_firstDayOfWeek, PROP_Calendar_timeTextField, PROP_CorridorInfo_enableGeocode, PROP_CorridorInfo_enableGeocode_country, PROP_CorridorInfo_mapControlLocation, PROP_CorridorInfo_pointCount, PROP_CorridorInfo_showShapeColor, PROP_DeviceAlerts_mapPageName, PROP_DeviceAlerts_maxActiveAlertAge, PROP_DeviceAlerts_refreshInterval, PROP_DeviceAlerts_showAllDevices, PROP_DeviceChooser_extraDebugEntries, PROP_DeviceChooser_idPosition, PROP_DeviceChooser_includeListHtml, PROP_DeviceChooser_matchContains, PROP_DeviceChooser_search, PROP_DeviceChooser_singleItemTextField, PROP_DeviceChooser_sortBy, PROP_DeviceChooser_useTable, PROP_DeviceInfo_allowDeleteDevice, PROP_DeviceInfo_allowEditFirmwareVersion, PROP_DeviceInfo_allowEditServerID, PROP_DeviceInfo_allowNewDevice, PROP_DeviceInfo_custom_, PROP_DeviceInfo_maximumIgnitionIndex, PROP_DeviceInfo_optimizeUpdateDevice, PROP_DeviceInfo_showAssignedUserID, PROP_DeviceInfo_showCommandState_, PROP_DeviceInfo_showDataKey, PROP_DeviceInfo_showDateCalendar, PROP_DeviceInfo_showDcsConfigString, PROP_DeviceInfo_showDcsPropertiesID, PROP_DeviceInfo_showDisplayColor, PROP_DeviceInfo_showExpectedAcks, PROP_DeviceInfo_showFaultCodes, PROP_DeviceInfo_showFixedLocation, PROP_DeviceInfo_showFuelCapacity, PROP_DeviceInfo_showFuelLevelProfile, PROP_DeviceInfo_showHoursOfOperation, PROP_DeviceInfo_showIgnitionIndex, PROP_DeviceInfo_showInputState_, PROP_DeviceInfo_showMaintenanceHours, PROP_DeviceInfo_showMaintenanceNotes, PROP_DeviceInfo_showMaintenanceOdometer, PROP_DeviceInfo_showNotes, PROP_DeviceInfo_showNotificationFields, PROP_DeviceInfo_showOutputState_, PROP_DeviceInfo_showPreferredGroupID, PROP_DeviceInfo_showPropertiesButton, PROP_DeviceInfo_showPushpinChooser, PROP_DeviceInfo_showPushpinID, PROP_DeviceInfo_showReminderMessage, PROP_DeviceInfo_showReportedEngineHours, PROP_DeviceInfo_showReportedOdometer, PROP_DeviceInfo_showServiceTime, PROP_DeviceInfo_showSmsButton, PROP_DeviceInfo_SMS_useDeviceSMSCommands, PROP_DeviceInfo_uniqueSimPhoneNumber, PROP_DriverInfo_showDateCalendar, PROP_DriverInfo_showDeviceID, PROP_EntityAdmin_entityType, PROP_FullMap_autoUpdateRecenter, PROP_FullMap_calendarAction, PROP_FullMap_calendarDateOnLoad, PROP_FullMap_detailAscending, PROP_FullMap_detailCenterPushpin, PROP_FullMap_enableGeocode, PROP_FullMap_enableGeocode_country, PROP_FullMap_fleetDeviceEventCount, PROP_FullMap_lastDevicePushpin_device, PROP_FullMap_lastDevicePushpin_fleet, PROP_FullMap_limitType, PROP_FullMap_mapControlCollapsible, PROP_FullMap_mapControlLocation, PROP_FullMap_mapUpdateOnLoad, PROP_FullMap_pageLinks, PROP_FullMap_showAllContainedGeozones, PROP_FullMap_showBatteryLevel, PROP_FullMap_showCursorLocation, PROP_FullMap_showDeviceLink, PROP_FullMap_showDistanceRuler, PROP_FullMap_showFleetMapDevicePushpin, PROP_FullMap_showGoogleKML, PROP_FullMap_showLegend, PROP_FullMap_showLocateNow, PROP_FullMap_showPushpinReplay, PROP_FullMap_showTimezoneSelection, PROP_FullMap_showUpdateAll, PROP_FullMap_showUpdateLast, PROP_FullMap_useRouteDisplayColor, PROP_GroupInfo_deviceListSortBy, PROP_GroupInfo_showPropertiesButton, PROP_MenuBar_includeTextAnchor, PROP_MenuBar_openOnMouseOver, PROP_MenuBar_usePullDownMenus, PROP_NewAccount_authCodeMask, PROP_ReportDisplay_showGoogleKML, PROP_ReportMenu_customFormatURL, PROP_ReportMenu_enableReportEmail, PROP_ReportMenu_enableReportSchedule, PROP_ReportMenu_showTimezoneSelection, PROP_ReportMenu_useMapDates, PROP_RuleInfo_ruleTagList, PROP_RuleInfo_showCronRules, PROP_RuleInfo_showEMailWrapper, PROP_RuleInfo_showPredefinedActions, PROP_RuleInfo_showSysRules, PROP_RuleInfo_showSysRulesOnly, PROP_RuleInfo_showTriggerActions, PROP_StatusCodeInfo_showIconSelector, PROP_StatusCodeInfo_showPushpinChooser, PROP_SysAccountsLogin_enableLogin, PROP_SysAccountsLogin_enableReturn, PROP_SysAccountsLogin_enableReturn_timeout, PROP_SysAccountsLogin_passcode, PROP_SysAdminAccounts_accountProperties, PROP_SysAdminAccounts_allowDeleteAccount, PROP_SysAdminAccounts_showAccountManager, PROP_SysAdminAccounts_showAllowWebService, PROP_SysAdminAccounts_showAutoAddDevices, PROP_SysAdminAccounts_showDataPushURL, PROP_SysAdminAccounts_showNotes, PROP_SysAdminAccounts_showPasswords, PROP_SysAdminAccounts_showRetainEvents, PROP_SysAdminInfo_showEventCount, PROP_SysAdminInfo_showEventsPerSecond, PROP_TopMenu_maximumIconsPerRow, PROP_TopMenu_menuType, PROP_TopMenu_showHeader, PROP_TopMenu_showMenuDescription, PROP_TopMenu_showMenuHelp, PROP_Track_editAfterNew, PROP_Track_enableAuthenticationService, PROP_Track_firstLoginPageID, PROP_Track_forwardToSecureAccess, PROP_Track_ValidateIDs, PROP_TrackMap_autoUpdateRecenter, PROP_TrackMap_calendarAction, PROP_TrackMap_calendarDateOnLoad, PROP_TrackMap_detailAscending, PROP_TrackMap_detailCenterPushpin, PROP_TrackMap_enableGeocode, PROP_TrackMap_enableGeocode_country, PROP_TrackMap_fleetDeviceEventCount, PROP_TrackMap_includeStatusCodeColor, PROP_TrackMap_lastDevicePushpin_device, PROP_TrackMap_lastDevicePushpin_fleet, PROP_TrackMap_limitType, PROP_TrackMap_mapControlCollapseOnLoad, PROP_TrackMap_mapControlCollapsible, PROP_TrackMap_mapControlLocation, PROP_TrackMap_mapUpdateOnLoad, PROP_TrackMap_pageLinks, PROP_TrackMap_showAllContainedGeozones, PROP_TrackMap_showBatteryLevel, PROP_TrackMap_showCursorLocation, PROP_TrackMap_showDeviceLink, PROP_TrackMap_showDistanceRuler, PROP_TrackMap_showFleetMapDevicePushpin, PROP_TrackMap_showGoogleKML, PROP_TrackMap_showLegend, PROP_TrackMap_showLocateNow, PROP_TrackMap_showLocationDetails, PROP_TrackMap_showNearbyGeozones, PROP_TrackMap_showPushpinReplay, PROP_TrackMap_showTimezoneSelection, PROP_TrackMap_showUpdateAll, PROP_TrackMap_showUpdateLast, PROP_TrackMap_sortableLocationDetails, PROP_TrackMap_useRouteDisplayColor, PROP_UserInfo_allowDuplicateContactEmail, PROP_UserInfo_authorizedGroupCount, PROP_UserInfo_custom_, PROP_UserInfo_showAccessControlList, PROP_UserInfo_showAddressFields, PROP_UserInfo_showNotes, PROP_UserInfo_showOfficeLocation, PROP_UserInfo_showPassword, PROP_UserInfo_showPreferredDeviceID, PROP_WorkZoneInfo_mapControlLocation, PROP_ZoneInfo_enableGeocode, PROP_ZoneInfo_enableGeocode_country, PROP_ZoneInfo_mapControlLocation, PROP_ZoneInfo_maximumDisplayedVertices, PROP_ZoneInfo_showArriveDepartCode, PROP_ZoneInfo_showArriveDepartZone, PROP_ZoneInfo_showAssignedDeviceGroup, PROP_ZoneInfo_showAutoNotify, PROP_ZoneInfo_showClientUploadZone, PROP_ZoneInfo_showCorridorID, PROP_ZoneInfo_showOverlapPriority, PROP_ZoneInfo_showPurposeID, PROP_ZoneInfo_showPushpins, PROP_ZoneInfo_showReverseGeocodeZone, PROP_ZoneInfo_showShapeColor, PROP_ZoneInfo_showSpeedLimit, PROP_ZoneInfo_zonePurposeList, RGNAME_ACTIVE, TIMEZONE_CONF

Constructor Summary

protected

PrivateLabel(java.lang.String host) Constructor

Method Summary

protected java.lang.String	_getWebPageJSP(RequestProperties reqState) Gets the default WebPage JSP URI (adjusted by RequestProperties)
void	addMapProvider(MapProvider mapProv) Adds a supported MapProvider.
void	clearTimeZones() Clears TimeZone cache
static java.lang.String	GetContextOfflineMessage() Gets the Context offline message.
java.lang.String	getCssDirectory() Gets the CSS directory
PageDecorations	getDefaultPageDecorations() Gets the default page decorations
<T extends java.lang.Enum<T>> ComboMap	getEnumComboMap(java.lang.Class<T> enumClass) Gets a ComboMap of the enumnerated values specified by the Enum class
<T extends java.lang.Enum<T>> ComboMap	getEnumComboMap(java.lang.Class<T> enumClass, T[] list) Gets a ComboMap of the enumnerated values specified by the Enum class
ComboOption	getEnumComboOption(EnumTools.StringLocale enumType) Gets a ComboOption encapsulating the specified Enum type
static java.lang.String	GetGlobalOfflineMessage() Gets the Global offline message.
static OrderedMap<java.lang.String,PushpinIcon>	GetGlobalPushpinIcons()
PrivateLabel.JSPEntry	getJSPEntry(java.lang.String jspName) Gets the named JSPEntry.
OrderedMap<java.lang.String,java.lang.String>	getJSPEntryDescriptions(java.util.Locale locale) Gets a map of JSPEntry names/descriptions
java.util.Set<java.lang.String>	getJSPEntryNames() Gets a set of JSPEntry names
java.lang.String	getJSPFile(java.lang.String jspName, boolean rtnDefault) Gets the named JSPEntry
MapProvider	getMapProvider() Returns the first MapProvider
MapProvider	getMapProvider(java.lang.String name) Gets the named MapProvider
int	getMapProviderCount() Returns the number of MapProviders
java.util.Map<java.lang.String,MapShape>	getMapShapes() Gets the global MapShapes
java.util.Map<java.lang.String,MenuGroup>	getMenuGroupMap() Gets the MenuGroup map
static java.lang.String	GetOfflineMessage() Gets the Context/Global offline message.
java.util.List<PoiProvider>	getPointsOfInterest() Gets the global PointsOfInterest
int	getPushpinIconIndex(java.lang.String mapProviderID, java.lang.String pushpinID, int dftIndex) Return the MapProvider's Pushpin index for the specified pushpin ID
ReportEntry	getReportEntry(java.lang.String rptName) Gets the named ReportFactory
ReportFactory	getReportFactory(java.lang.String rptName) Gets the named ReportFactory
java.util.Map<java.lang.String,ReportEntry>	getReportMap() Gets the ReportEntry map
ComboMap	getTimeZoneComboMap() Gets a ComboMap of supported TimeZones
PageDecorations	getUserPageDecorations() Gets the user page decorations
WebPage	getWebPage(java.lang.String pageName) Gets the named WebPage
java.lang.String	getWebPageJSP() Gets the assigned WebPage JSP URI
java.lang.String	getWebPageJSP(java.lang.String jsp, RequestProperties reqState) Gets the WebPage JSP URI
java.util.Map<java.lang.String,WebPage>	getWebPageMap() Gets the WebPage map
java.lang.String	getWebPageURL(RequestProperties reqState, java.lang.String pageName) Gets the URL to the named WebPage
java.lang.String	getWebPageURL(RequestProperties reqState, java.lang.String pageName, java.lang.String command) Gets the URL to the named WebPage
java.lang.String	getWebPageURL(RequestProperties reqState, java.lang.String pageName, java.lang.String command, java.lang.String arg) Gets the URL to the named WebPage
boolean	hasReport(java.lang.String rptName) Returns true if the named ReportFactory has been defined
boolean	hasUserPageDecorations() Returns true if user page decorations have been defined
boolean	hasWebPage(java.lang.String pageName) Returns true if the named WebPage is defined
java.lang.String	resolveCssFile(java.lang.String cssFileName, java.lang.String cssFileDir) Resolves the path to the specified CSS dir/file
static void	SetContextOfflineMessage(java.lang.String msg) Sets the context offline message Note: This method effects only the Context offline settings.
void	setCssDirectory(java.lang.String cssDir) Sets the CSS directory
void	setDefaultPageDecorations(PageDecorations pd) Sets the default page decorations
void	setJSPMap(java.util.Map<java.lang.String,PrivateLabel.JSPEntry> jspMap) Sets the JSPEntry map
void	setMapShapes(java.util.List<MapShape> shapeList) Sets the global MapShapes
void	setMenuGroupMap(java.util.Map<java.lang.String,MenuGroup> menuGroupMap) Sets the MenuGroup map
void	setPointsOfInterest(java.util.List<PoiProvider> poiList) Sets the global PointsOfInterest
void	setReportMap(java.util.Map<java.lang.String,ReportEntry> reportMap) Sets the ReportEntry map
void	setUserPageDecorations(PageDecorations pd) Sets the user page decorations
void	setWebPageJSP(java.lang.String dftJSP) Sets the default JSP URI
void	setWebPageMap(java.util.Map<java.lang.String,WebPage> pageMap) Sets the WebPage map

Methods inherited from class org.opengts.db.BasicPrivateLabel

addAclMap, addGeocodeProvider, addHostAlias, addMobileLocationProvider, addReverseGeocodeProvider, addStatusCode, getAccessLevel, getAccessLevel, getAccountLogin, getAclEntry, getAllAclEntries, getAllowEmailLogin, getAllTimeZones, getBooleanProperty, getCopyright, getCustomStatusCodeMap, getDateFormat, getDateStringFormat, getDateStringFormat, getDateStringFormatText, getDefaultAccessLevel, getDefaultAccessLevel, getDefaultBaseURL, getDefaultDateFormat, getDefaultLoginAccount, getDefaultLoginUser, getDefaultTimeFormat, getDomainName, getDoubleProperty, getEMailAddress, getEMailAddresses, getEnableDemo, getEventNotificationBody, getEventNotificationDefault, getEventNotificationFrom, getEventNotificationSubject, getGeocodeProvider, getGeocodeProvider, getHostAliasNames, getHostName, getI18N, getI18N, getI18NTextString, getIntProperty, getLocale, getLocaleString, getLongProperty, getMaximumAccessLevel, getMobileLocationProvider, getMobileLocationProvider, getName, getPageTitle, getPasswordHandler, getPredefinedRuleActions, getProperty, getPropertyKeys, getPushpinIconIndex, getReverseGeocodeProvider, getReverseGeocodeProvider, getRTProperties, getShowPassword, getSmtpProperties, getStatusCode, getStatusCode, getStatusCodeDescriptionMap, getStatusCodeList, getStatusCodeOnly, getStringProperty, GetSupportedLocaleMap, getSystemAccountsLoginPasscode, getSystemAccountsLoginReturnTimeout, getTimeFormat, getTimeZones, getTimeZonesArray, getTimeZonesList, getUserLogin, globalEditAfterNew, globalValidateIDs, hasAclEntry, hasAllAccess, hasDefaultBaseURL, hasEventNotificationEMail, hasProperty, hasReadAccess, HasSupportedLocalesMap, hasWriteAccess, isDateFormatDMY, isDateFormatMDY, isDateFormatYMD, isRestricted, isSystemAccountsLoginEnabled, isSystemAccountsLoginReturnEnabled, isTrackServlet, popRTProperties, postInitialization, printProperties, printProperties, pushRTProperties, removeAclEntry, setAccountLogin, setAllowEmailLogin, setCopyright, setDateFormat, setDefaultBaseURL, setDefaultLoginAccount, setDefaultLoginUser, setDomainName, setEMailAddress, setEnableDemo, setEventNotificationEMail, setHostName, setI18NTextProperty, setLocaleString, setPageTitle, setPageTitle, setPasswordHandler, setPredefinedRulesActions, setProperty, setRestricted, setRTProperties, setShowPassword, setSmtpProperties, setStatusCodeOnly, setStringProperty, SetSupportedLocalesMap, setTimeFormat, setTimeZones, setTimeZones, setTimeZones, setTrackServlet_loaderOnly, setUserLogin, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CSS_DIR

public static final java.lang.String DEFAULT_CSS_DIR

See Also:

Constant Field Values

JSPENTRY_DEFAULT

public static final java.lang.String JSPENTRY_DEFAULT

See Also:

Constant Field Values

CONTEXT_FILE_OFFLINE

public static final java.lang.String CONTEXT_FILE_OFFLINE

See Also:

Constant Field Values

Constructor Detail

PrivateLabel

protected PrivateLabel(java.lang.String host)

Constructor

Parameters:

host - host/domain name

Method Detail

GetGlobalPushpinIcons

public static OrderedMap<java.lang.String,PushpinIcon> GetGlobalPushpinIcons()

hasUserPageDecorations

public boolean hasUserPageDecorations()

Returns true if user page decorations have been defined

Returns:

True if user page decorations have been defined

setUserPageDecorations

public void setUserPageDecorations(PageDecorations pd)

Sets the user page decorations

Parameters:

pd - The user page decorations

getUserPageDecorations

public PageDecorations getUserPageDecorations()

Gets the user page decorations

Returns:

The user page decorations

setDefaultPageDecorations

public void setDefaultPageDecorations(PageDecorations pd)

Sets the default page decorations

Parameters:

pd - The default page decorations

getDefaultPageDecorations

public PageDecorations getDefaultPageDecorations()

Gets the default page decorations

Returns:

The default page decorations

addMapProvider

public void addMapProvider(MapProvider mapProv)

Adds a supported MapProvider.

Parameters:

mapProv - The MapProvider

getMapProvider

public MapProvider getMapProvider()

Returns the first MapProvider

Returns:

The first MapProverer

getMapProvider

public MapProvider getMapProvider(java.lang.String name)

Gets the named MapProvider

Parameters:

name - The name of the MapProvider to return

getMapProviderCount

public int getMapProviderCount()

Returns the number of MapProviders

Returns:

The number of MapProviders

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

Overrides:

getPushpinIconIndex in class BasicPrivateLabel

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

setWebPageJSP

public void setWebPageJSP(java.lang.String dftJSP)

Sets the default JSP URI

Parameters:

dftJSP - The default JSP URI (may be a name, or absolute URI path entry)

getWebPageJSP

public java.lang.String getWebPageJSP()

Gets the assigned WebPage JSP URI

Returns:

The assigned WebPage JSP URI

_getWebPageJSP

protected java.lang.String _getWebPageJSP(RequestProperties reqState)

Gets the default WebPage JSP URI (adjusted by RequestProperties)

Returns:

The WebPage JSP URI

getWebPageJSP

public java.lang.String getWebPageJSP(java.lang.String jsp,
                                      RequestProperties reqState)

Gets the WebPage JSP URI

Returns:

The default JSP URI

setCssDirectory

public void setCssDirectory(java.lang.String cssDir)

Sets the CSS directory

Parameters:

cssDir - The CSS directory

getCssDirectory

public java.lang.String getCssDirectory()

Gets the CSS directory

Returns:

The CSS directory

resolveCssFile

public java.lang.String resolveCssFile(java.lang.String cssFileName,
                                       java.lang.String cssFileDir)

Resolves the path to the specified CSS dir/file

Parameters:

cssFileName - The CSS file name

cssFileDir - An optional CSS file directory

Returns:

The resolved CSS file paths

GetContextOfflineMessage

public static java.lang.String GetContextOfflineMessage()

Gets the Context offline message. Returns null if the Context has not been placed offline.

Returns:

The Context offline message, or null if the Context is not offline. Note: Global offline may still be in effect.

GetGlobalOfflineMessage

public static java.lang.String GetGlobalOfflineMessage()

Gets the Global offline message. Returns null if Global offline is not in effect.

Returns:

The Global offline message, or null if Global offline is not in effect. Note: Context offline may still be in effect.

GetOfflineMessage

public static java.lang.String GetOfflineMessage()

Gets the Context/Global offline message. Returns null if the system is online.

Returns:

The Context/Global offline message, or null if the system is online.

SetContextOfflineMessage

public static void SetContextOfflineMessage(java.lang.String msg)

Sets the context offline message
Note: This method effects only the Context offline settings. Any global offlines setting will not be effected.

Parameters:

msg - The offline message, or 'null' to place back 'online'

setWebPageMap

public void setWebPageMap(java.util.Map<java.lang.String,WebPage> pageMap)

Sets the WebPage map

Parameters:

pageMap - The WebPage map

getWebPageMap

public java.util.Map<java.lang.String,WebPage> getWebPageMap()

Gets the WebPage map

Returns:

pageMap The WebPage map

getWebPage

public WebPage getWebPage(java.lang.String pageName)

Gets the named WebPage

Parameters:

pageName - The name of the WebPage to return

Returns:

The named WebPage, or null if the named page does not exist

hasWebPage

public boolean hasWebPage(java.lang.String pageName)

Returns true if the named WebPage is defined

Parameters:

pageName - The name of the WebPage to test

Returns:

True if the named WebPage is defined

getWebPageURL

public java.lang.String getWebPageURL(RequestProperties reqState,
                                      java.lang.String pageName)

Gets the URL to the named WebPage

Parameters:

pageName - The name of the WebPage

reqState - The RequestProperties

Returns:

The URL to the named WebPage, or null if the named page does not exist

getWebPageURL

public java.lang.String getWebPageURL(RequestProperties reqState,
                                      java.lang.String pageName,
                                      java.lang.String command)

Gets the URL to the named WebPage

Parameters:

pageName - The name of the WebPage

reqState - The RequestProperties

command - The command to append to the URL

Returns:

The URL to the named WebPage, or null if the named page does not exist

getWebPageURL

public java.lang.String getWebPageURL(RequestProperties reqState,
                                      java.lang.String pageName,
                                      java.lang.String command,
                                      java.lang.String arg)

Gets the URL to the named WebPage

Parameters:

pageName - The name of the WebPage

reqState - The RequestProperties

command - The command to append to the URL

arg - The command argument to append to the URL

Returns:

The URL to the named WebPage, or null if the named page does not exist

setMenuGroupMap

public void setMenuGroupMap(java.util.Map<java.lang.String,MenuGroup> menuGroupMap)

Sets the MenuGroup map

Parameters:

menuGroupMap - The MenuGroup map

getMenuGroupMap

public java.util.Map<java.lang.String,MenuGroup> getMenuGroupMap()

Gets the MenuGroup map

Returns:

The MenuGroup map

setReportMap

public void setReportMap(java.util.Map<java.lang.String,ReportEntry> reportMap)

Sets the ReportEntry map

Parameters:

reportMap - The ReportEntry map

getReportMap

public java.util.Map<java.lang.String,ReportEntry> getReportMap()

Gets the ReportEntry map

Returns:

The ReportEntry map

getReportEntry

public ReportEntry getReportEntry(java.lang.String rptName)

Gets the named ReportFactory

Parameters:

rptName - The ReportFactory name to return

Returns:

The named ReportFactory

getReportFactory

public ReportFactory getReportFactory(java.lang.String rptName)

Gets the named ReportFactory

Parameters:

rptName - The ReportFactory name to return

Returns:

The named ReportFactory

hasReport

public boolean hasReport(java.lang.String rptName)

Returns true if the named ReportFactory has been defined

Parameters:

rptName - The ReportFactory name to test

Returns:

True if the named ReportFactory has been defined

setJSPMap

public void setJSPMap(java.util.Map<java.lang.String,PrivateLabel.JSPEntry> jspMap)

Sets the JSPEntry map

Parameters:

jspMap - The JSPEntry map

getJSPEntryNames

public java.util.Set<java.lang.String> getJSPEntryNames()

Gets a set of JSPEntry names

Returns:

A set of JSPEntry names

getJSPEntryDescriptions

public OrderedMap<java.lang.String,java.lang.String> getJSPEntryDescriptions(java.util.Locale locale)

Gets a map of JSPEntry names/descriptions

Returns:

A set of JSPEntry names/descriptions

getJSPEntry

public PrivateLabel.JSPEntry getJSPEntry(java.lang.String jspName)

Gets the named JSPEntry.
Can be overidden with property "JSPEntry.". If the "default" JSP Entry is preconfigured, then overiding with property key "JSPEntry.default" will allow mapping other JSP enties.

Parameters:

jspName - The JSPEntry name to return

Returns:

The named JSPEntry

getJSPFile

public java.lang.String getJSPFile(java.lang.String jspName,
                                   boolean rtnDefault)

Gets the named JSPEntry

Parameters:

jspName - The JSPEntry name to return

rtnDefault - True to return "default" JSP if jsp name is not found

Returns:

The named JSPEntry

setPointsOfInterest

public void setPointsOfInterest(java.util.List<PoiProvider> poiList)

Sets the global PointsOfInterest

Parameters:

poiList - The PointsOfInterest list

getPointsOfInterest

public java.util.List<PoiProvider> getPointsOfInterest()

Gets the global PointsOfInterest

Overrides:

getPointsOfInterest in class BasicPrivateLabel

Returns:

The PointsOfInterest list

setMapShapes

public void setMapShapes(java.util.List<MapShape> shapeList)

Sets the global MapShapes

Parameters:

shapeList - The MapShape list

getMapShapes

public java.util.Map<java.lang.String,MapShape> getMapShapes()

Gets the global MapShapes

Returns:

The MapShapes list

clearTimeZones

public void clearTimeZones()

Clears TimeZone cache

Overrides:

clearTimeZones in class BasicPrivateLabel

getTimeZoneComboMap

public ComboMap getTimeZoneComboMap()

Gets a ComboMap of supported TimeZones

Returns:

The ComboMap of supported TimeZones

getEnumComboMap

public <T extends java.lang.Enum<T>> ComboMap getEnumComboMap(java.lang.Class<T> enumClass)

Gets a ComboMap of the enumnerated values specified by the Enum class

Returns:

The ComboMap

getEnumComboMap

public <T extends java.lang.Enum<T>> ComboMap getEnumComboMap(java.lang.Class<T> enumClass,
                                                              T[] list)

Gets a ComboMap of the enumnerated values specified by the Enum class

Returns:

The ComboMap

getEnumComboOption

public ComboOption getEnumComboOption(EnumTools.StringLocale enumType)

Gets a ComboOption encapsulating the specified Enum type

Returns:

The ComboOption