com.hds.hcpaw.fss.api.model

Class BrandingInfo

java.lang.Object

com.hds.hcpaw.fss.api.model.BaseFssApiResource

com.hds.hcpaw.fss.api.model.BrandingInfo

public class BrandingInfo
extends BaseFssApiResource

Field Summary

Fields inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

UTF_8

Method Summary

Modifier and Type	Method and Description
static BrandingInfo	create(FssApiVersion apiVersion, java.lang.String productName, java.lang.Boolean productNameBranded, java.lang.String description, java.lang.String poweredByName, java.lang.String msTeamsAppName, java.lang.String loginHelpMessageLink, java.lang.Boolean logoImageBranded, java.lang.String logoImageBrandedPath, java.lang.Boolean poweredByImageBranded, java.lang.String poweredByImageBrandedPath, java.lang.Boolean faviconImageBranded, java.lang.String faviconImageBrandedPath, java.lang.Boolean eulaHtmlBranded, java.lang.String eulaHtmlBrandedPath, java.lang.Boolean loginHelpHtmlBranded, java.lang.String loginHelpHtmlBrandedPath, java.lang.Boolean networkLoginEnabled, java.lang.String loginLogoImageBrandedPath, java.lang.Boolean loginLogoImageBranded, java.lang.Boolean showProductName, java.awt.Dimension logoDimension, java.awt.Dimension loginLogoDimension, java.awt.Dimension poweredByLogoDimension, java.awt.Dimension tabLogoDimension) Returns a versioned BrandingInfo that is compatible with the specified apiVersion.
boolean	equals(java.lang.Object o)
java.lang.String	getDescription() Returns the description set under Product for branding.
java.lang.String	getEulaHtmlBrandedPath() Returns the path of the EULA HTML, if it is branded.
java.lang.String	getFaviconImageBrandedPath() Returns the path of the favicon image, if it is branded.
static java.lang.Class<? extends BrandingInfo>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the BrandingInfo that corresponds to the specified apiVersion.
java.lang.String	getLoginHelpHtmlBrandedPath() Returns the path of the login help HTML, if it is branded.
java.lang.String	getLoginHelpMessageLink() Returns the text set for the Login Help Message Link.
java.awt.Dimension	getLoginLogoDimension() Returns the login logo dimensions
java.lang.Boolean	getLoginLogoImageBranded() Returns whether or not the login logo image for HCPAW is branded.
java.lang.String	getLoginLogoImageBrandedPath() Returns the path of the login logo image, if it is branded.
java.awt.Dimension	getLogoDimension() Returns the product logo dimension
java.lang.String	getLogoImageBrandedPath() Returns the path of the logo image, if it is branded.
java.lang.String	getMSTeamsAppName() Returns the name set under HCP Anywhere for MS Teams.
java.lang.String	getPoweredByImageBrandedPath() Returns the path of the powered by image, if it is branded.
java.awt.Dimension	getPoweredByLogoDimension() Returns the powerbylogo dimensions
java.lang.String	getPoweredByName() Returns the name set under Powered By for branding.
java.lang.String	getProductName() Returns the name set under Product for branding.
java.lang.Boolean	getProductNameBranded() Returns if the product name is branded.
java.awt.Dimension	getTabLogoDimension() Returns the tab logo (or favicon) dimension
int	hashCode()
java.lang.Boolean	isEulaHtmlBranded() Returns whether the EULA is branded.
java.lang.Boolean	isFaviconImageBranded() Returns whether the favicon image for HCPAW is branded.
java.lang.Boolean	isLoginHelpHtmlBranded() Returns whether the login help is branded.
java.lang.Boolean	isLogoImageBranded() Returns whether or not the logo image for HCPAW is branded.
java.lang.Boolean	isNetworkLoginEnabled() Returns whether network login is enabled
java.lang.Boolean	isPoweredByImageBranded() Returns whether or not the Powered By image for HCPAW is branded.
java.lang.Boolean	isProductNameShown() Returns whether the product name is shown
protected void	validate(java.lang.String fieldName, BaseFssApiResource parent) Validates this object.

Methods inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

badValue, badValue, fromJson, toJson, toJson, toString, validate, validateFieldInRange, validateFieldInRange, validateFieldIsNull, validateFieldNotNull, validateLocale, validateOptionalField, validateOptionalFieldList, validateRequiredField, validateRequiredFieldList, writeToOutputStream

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getFssApiClass

public static java.lang.Class<? extends BrandingInfo> getFssApiClass(FssApiVersion apiVersion)
                                                              throws AwUnsupportedApiVersionException

Returns the Class of the BrandingInfo that corresponds to the specified apiVersion.

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the BrandingInfo that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static BrandingInfo create(FssApiVersion apiVersion,
                                  java.lang.String productName,
                                  java.lang.Boolean productNameBranded,
                                  java.lang.String description,
                                  java.lang.String poweredByName,
                                  java.lang.String msTeamsAppName,
                                  java.lang.String loginHelpMessageLink,
                                  java.lang.Boolean logoImageBranded,
                                  java.lang.String logoImageBrandedPath,
                                  java.lang.Boolean poweredByImageBranded,
                                  java.lang.String poweredByImageBrandedPath,
                                  java.lang.Boolean faviconImageBranded,
                                  java.lang.String faviconImageBrandedPath,
                                  java.lang.Boolean eulaHtmlBranded,
                                  java.lang.String eulaHtmlBrandedPath,
                                  java.lang.Boolean loginHelpHtmlBranded,
                                  java.lang.String loginHelpHtmlBrandedPath,
                                  java.lang.Boolean networkLoginEnabled,
                                  java.lang.String loginLogoImageBrandedPath,
                                  java.lang.Boolean loginLogoImageBranded,
                                  java.lang.Boolean showProductName,
                                  java.awt.Dimension logoDimension,
                                  java.awt.Dimension loginLogoDimension,
                                  java.awt.Dimension poweredByLogoDimension,
                                  java.awt.Dimension tabLogoDimension)
                           throws AwUnsupportedApiVersionException

Returns a versioned BrandingInfo that is compatible with the specified apiVersion.

Parameters:

apiVersion - API version to be supported by the BrandingInfo

productName - The Product name set for branding.

description - The Product description set for branding.

poweredByName - The Powered By name set for branding.

msTeamsAppName - The name displayed for the app in Microsoft Teams

loginHelpMessageLink - The Login Help Message Link text set for branding.

logoImageBranded - Whether or not the logo image is branded.

logoImageBrandedPath - The path of the logo image, if it is branded.

poweredByImageBranded - Whether or not the powered by image is branded.

poweredByImageBrandedPath - The path of the powered by image, if it is branded.

faviconImageBranded - Whether or not the favicon image is branded.

faviconImageBrandedPath - The path of the favicon image, if it is branded.

eulaHtmlBranded - Whether or not the EULA html is branded.

eulaHtmlBrandedPath - The path of the EULA html, if it is branded.

loginHelpHtmlBranded - Whether or not the login help HTML is branded.

loginHelpHtmlBrandedPath - The path of the login help HTML, if it is branded.

networkLoginEnabled - Whether or not network login is enabled

showProductName - Whether the product name is shown

logoDimension - the dimensions of the logo (product logo)

loginLogoDimension - the dimensions of the loginLogo

poweredByLogoDimension - the dimensions of poweredByLogo

tabLogoDimension - the dimensions of the tab logo (favicon

Returns:

BrandingInfo object

Throws:

AwUnsupportedApiVersionException

getProductName

public java.lang.String getProductName()

Returns the name set under Product for branding.

Returns:

the name set under Product for branding.

getProductNameBranded

public java.lang.Boolean getProductNameBranded()

Returns if the product name is branded. True if it is, False if it is the default.

Returns:

if the product name is branded

getDescription

public java.lang.String getDescription()

Returns the description set under Product for branding.

Returns:

the description set under Product for branding.

getPoweredByName

public java.lang.String getPoweredByName()

Returns the name set under Powered By for branding.

Returns:

the name set under Powered By for branding.

getMSTeamsAppName

public java.lang.String getMSTeamsAppName()

Returns the name set under HCP Anywhere for MS Teams.

Returns:

the name set under HCP Anywhere for MS Teams.

getLoginHelpMessageLink

public java.lang.String getLoginHelpMessageLink()

Returns the text set for the Login Help Message Link.

Returns:

the text set for the Login Help Message Link.

isLogoImageBranded

public java.lang.Boolean isLogoImageBranded()

Returns whether or not the logo image for HCPAW is branded.

Returns:

whether or not the logo image for HCPAW is branded.

isPoweredByImageBranded

public java.lang.Boolean isPoweredByImageBranded()

Returns whether or not the Powered By image for HCPAW is branded.

Returns:

whether or not the Powered By image for HCPAW is branded.

isFaviconImageBranded

public java.lang.Boolean isFaviconImageBranded()

Returns whether the favicon image for HCPAW is branded.

Returns:

whether the favicon image for HCPAW is branded.

isEulaHtmlBranded

public java.lang.Boolean isEulaHtmlBranded()

Returns whether the EULA is branded.

Returns:

whether the EULA is branded.

isLoginHelpHtmlBranded

public java.lang.Boolean isLoginHelpHtmlBranded()

Returns whether the login help is branded.

Returns:

whether the login help is branded.

isNetworkLoginEnabled

public java.lang.Boolean isNetworkLoginEnabled()

Returns whether network login is enabled

Returns:

whether network login is enabled

getLogoImageBrandedPath

public java.lang.String getLogoImageBrandedPath()

Returns the path of the logo image, if it is branded.

Returns:

the path of the logo image, if it is branded.

getPoweredByImageBrandedPath

public java.lang.String getPoweredByImageBrandedPath()

Returns the path of the powered by image, if it is branded.

Returns:

the path of the powered by image, if it is branded.

getFaviconImageBrandedPath

public java.lang.String getFaviconImageBrandedPath()

Returns the path of the favicon image, if it is branded.

Returns:

the path of the favicon image, if it is branded.

getEulaHtmlBrandedPath

public java.lang.String getEulaHtmlBrandedPath()

Returns the path of the EULA HTML, if it is branded.

Returns:

the path of the EULA HTML, if it is branded.

getLoginHelpHtmlBrandedPath

public java.lang.String getLoginHelpHtmlBrandedPath()

Returns the path of the login help HTML, if it is branded.

Returns:

the path of the login help HTML, if it is branded.

getLoginLogoImageBrandedPath

public java.lang.String getLoginLogoImageBrandedPath()

Returns the path of the login logo image, if it is branded.

Returns:

the path of the login logo image, if it is branded.

getLoginLogoImageBranded

public java.lang.Boolean getLoginLogoImageBranded()

Returns whether or not the login logo image for HCPAW is branded.

Returns:

whether or not the login logo image for HCPAW is branded.

isProductNameShown

public java.lang.Boolean isProductNameShown()

Returns whether the product name is shown

Returns:

is the product name shown

getLogoDimension

public java.awt.Dimension getLogoDimension()

Returns the product logo dimension

Returns:

product Logo dimensions

getLoginLogoDimension

public java.awt.Dimension getLoginLogoDimension()

Returns the login logo dimensions

Returns:

login logo dimensions

getPoweredByLogoDimension

public java.awt.Dimension getPoweredByLogoDimension()

Returns the powerbylogo dimensions

Returns:

powerbylogo

getTabLogoDimension

public java.awt.Dimension getTabLogoDimension()

Returns the tab logo (or favicon) dimension

Returns:

tab logo dimensions otherwise known as favicon

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

validate

protected void validate(java.lang.String fieldName,
                        BaseFssApiResource parent)
                 throws AwJsonException

Description copied from class: BaseFssApiResource

Validates this object. Implementers of this method should call the various validate methods in this class for the fields in the class. For example, if an implementing class has a required field called foo and an optional field called bar, then this method should call BaseFssApiResource.validateRequiredField(String, BaseFssApiResource, String) for foo, and BaseFssApiResource.validateOptionalField(String, BaseFssApiResource) for bar.

Specified by:

validate in class BaseFssApiResource

Parameters:

fieldName - name of this object in the parent (containing) object. If this object is a top-level object (not contained within another object), then enter null for this parameter

parent - parent (containing) object that contains the object specified in the fieldName parameter. If this object is a top-level object (not contained within another object), then enter null for this parameter

Throws:

AwJsonException - if any validation errors occur