FlashSiteInfo

java.lang.Object
- com.dpslink.base.obj.MappedAttributesObject
- - com.dpslink.flash.util.FlashSiteInfo

All Implemented Interfaces:

java.io.Serializable
```
public class FlashSiteInfo
extends MappedAttributesObject
```
Defines the Flash site's information object. Contains general information about the site's company; such as name, address, phone numbers. Primarily used to provide site information to the template processor for email and html templates. A variable for this class ($SiteInfo) is automatically added to the template processor Velocity context by the FlashMailMessage and FlashServlet classes.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private static FlashSiteInfo`	`cvInstance` The shared instance of this class.
`private static long`	`serialVersionUID` The class' serialization version id.

Fields inherited from class com.dpslink.base.obj.MappedAttributesObject
ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors
Modifier Constructor and Description

private FlashSiteInfo()
Constructs a new site information object.

Constructors
Modifier	Constructor and Description
`private`	`FlashSiteInfo()` Constructs a new site information object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` Compares the given object to this object and determines if the two are equal.
`java.lang.String`	`getAcronym()` Returns the site's acronym (initials).
`java.lang.String`	`getAddress1()` Returns the site's address line 1.
`java.lang.String`	`getAddress2()` Returns the site's address line 2.
`java.lang.String`	`getAddress3()` Returns the site's address line 3.
`java.lang.String`	`getAddress4()` Returns the site's address line 4.
`java.lang.String`	`getAdmEmailAddr()` Returns the site's administrator email address.
`java.lang.String`	`getAdmEmailName()` Returns the site's administrator email name.
`java.lang.String`	`getCommonName()` Returns the site's common name.
`java.lang.String`	`getCorporateURL()` Returns the site's corporate web site url.
`java.lang.String`	`getFormalName()` Returns the site's formal name.
`java.lang.String`	`getPhone1()` Returns the site's phone number 1.
`java.lang.String`	`getPhone1Descr()` Returns the site's phone number 1 description.
`java.lang.String`	`getPhone2()` Returns the site's phone number 2.
`java.lang.String`	`getPhone2Descr()` Returns the site's phone number 2 description.
`java.lang.String`	`getPhone3()` Returns the site's phone number 3.
`java.lang.String`	`getPhone3Descr()` Returns the site's phone number 3 description.
`java.lang.String`	`getPhone4()` Returns the site's phone number 4.
`java.lang.String`	`getPhone4Descr()` Returns the site's phone number 4 description.
`java.lang.String`	`getSlsEmailAddr()` Returns the site's sales email address.
`java.lang.String`	`getSlsEmailName()` Returns the site's sales email name.
`java.lang.String`	`getSvcEmailAddr()` Returns the site's customer service email address.
`java.lang.String`	`getSvcEmailName()` Returns the site's customer service email name.
`static FlashSiteInfo`	`instance()` Returns the shared instance of the this class.
`void`	`setAcronym(java.lang.String value)` Sets the site's acronym (initials).
`void`	`setAddress1(java.lang.String value)` Sets the site's address line 1.
`void`	`setAddress2(java.lang.String value)` Sets the site's address line 2.
`void`	`setAddress3(java.lang.String value)` Sets the site's address line 3.
`void`	`setAddress4(java.lang.String value)` Sets the site's address line 4.
`void`	`setAdmEmailAddr(java.lang.String value)` Sets the site's administrator email address.
`void`	`setAdmEmailName(java.lang.String value)` Sets the site's administrator email name.
`void`	`setCommonName(java.lang.String value)` Sets the site's common name.
`void`	`setCorporateURL(java.lang.String value)` Sets the site's corporate web site url.
`void`	`setFormalName(java.lang.String value)` Sets the site's formal name.
`void`	`setPhone1(java.lang.String value)` Sets the site's phone number 1.
`void`	`setPhone1Descr(java.lang.String value)` Sets the site's phone number 1 description.
`void`	`setPhone2(java.lang.String value)` Sets the site's phone number 2.
`void`	`setPhone2Descr(java.lang.String value)` Sets the site's phone number 2 description.
`void`	`setPhone3(java.lang.String value)` Sets the site's phone number 3.
`void`	`setPhone3Descr(java.lang.String value)` Sets the site's phone number 3 description.
`void`	`setPhone4(java.lang.String value)` Sets the site's phone number 4.
`void`	`setPhone4Descr(java.lang.String value)` Sets the site's phone number 4 description.
`void`	`setSlsEmailAddr(java.lang.String value)` Sets the site's sales email address.
`void`	`setSlsEmailName(java.lang.String value)` Sets the site's sales email name.
`void`	`setSvcEmailAddr(java.lang.String value)` Sets the site's customer service email address.
`void`	`setSvcEmailName(java.lang.String value)` Sets the site's customer service email name.

Methods inherited from class com.dpslink.base.obj.MappedAttributesObject
cloneMapAttributes, formatValue, formatValue, getHashFields, getMapArrayList, getMapAttributes, getMapBigDecimal, getMapBoolean, getMapDate, getMapDouble, getMapInteger, getMapLong, getMapMapped, getMapObject, getMapShort, getMapString, getMapString, getMapStringBuffer, getMapStringBuilder, getMapTime, getMapTimestamp, getMapVector, hashCode, setHashFields, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMapAttributes, setMapObject, setMapTime, setMapTimestamp, toStringArray

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    The class' serialization version id.
    
    See Also:
    
    Constant Field Values
  - cvInstance
```
private static FlashSiteInfo cvInstance
```
    The shared instance of this class.
- Constructor Detail
  - FlashSiteInfo
```
private FlashSiteInfo()
```
    Constructs a new site information object. Initializes field values to corresponding values found in properties.
- Method Detail
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Compares the given object to this object and determines if the two are equal. This implemenation always returns true.
    
    Specified by:
    
    equals in class MappedAttributesObject
    
    Parameters:
    
    obj - (Object) The object to compare with this object.
    
    Returns:
    
    boolean - true if the specified object is equal to this object, otherwise false.
  - instance
```
public static FlashSiteInfo instance()
```
    Returns the shared instance of the this class.
    
    Returns:
    
    FlashSiteInfo - The shared instance of this class.
  - getAcronym
```
public java.lang.String getAcronym()
```
    Returns the site's acronym (initials).
    
    Returns:
    
    String - The acronym.
  - setAcronym
```
public void setAcronym(java.lang.String value)
```
    Sets the site's acronym (initials).
    
    Parameters:
    
    value - (String) The acronym.
  - getFormalName
```
public java.lang.String getFormalName()
```
    Returns the site's formal name.
    
    Returns:
    
    String - The formal name.
  - setFormalName
```
public void setFormalName(java.lang.String value)
```
    Sets the site's formal name.
    
    Parameters:
    
    value - (String) The formal name.
  - getCommonName
```
public java.lang.String getCommonName()
```
    Returns the site's common name.
    
    Returns:
    
    String - The common name.
  - setCommonName
```
public void setCommonName(java.lang.String value)
```
    Sets the site's common name.
    
    Parameters:
    
    value - (String) The common name.
  - getAddress1
```
public java.lang.String getAddress1()
```
    Returns the site's address line 1.
    
    Returns:
    
    String - The address line 1.
  - setAddress1
```
public void setAddress1(java.lang.String value)
```
    Sets the site's address line 1.
    
    Parameters:
    
    value - (String) The address line 1.
  - getAddress2
```
public java.lang.String getAddress2()
```
    Returns the site's address line 2.
    
    Returns:
    
    String - The address line 2.
  - setAddress2
```
public void setAddress2(java.lang.String value)
```
    Sets the site's address line 2.
    
    Parameters:
    
    value - (String) The address line 2.
  - getAddress3
```
public java.lang.String getAddress3()
```
    Returns the site's address line 3.
    
    Returns:
    
    String - The address line 3.
  - setAddress3
```
public void setAddress3(java.lang.String value)
```
    Sets the site's address line 3.
    
    Parameters:
    
    value - (String) The address line 3.
  - getAddress4
```
public java.lang.String getAddress4()
```
    Returns the site's address line 4.
    
    Returns:
    
    String - The address line 4.
  - setAddress4
```
public void setAddress4(java.lang.String value)
```
    Sets the site's address line 4.
    
    Parameters:
    
    value - (String) The address line 4.
  - getPhone1Descr
```
public java.lang.String getPhone1Descr()
```
    Returns the site's phone number 1 description.
    
    Returns:
    
    String - The phone number 1 description.
  - setPhone1Descr
```
public void setPhone1Descr(java.lang.String value)
```
    Sets the site's phone number 1 description.
    
    Parameters:
    
    value - (String) The phone number 1 description.
  - getPhone1
```
public java.lang.String getPhone1()
```
    Returns the site's phone number 1.
    
    Returns:
    
    String - The phone number 1.
  - setPhone1
```
public void setPhone1(java.lang.String value)
```
    Sets the site's phone number 1.
    
    Parameters:
    
    value - (String) The phone number 1.
  - getPhone2Descr
```
public java.lang.String getPhone2Descr()
```
    Returns the site's phone number 2 description.
    
    Returns:
    
    String - The phone number 2 description.
  - setPhone2Descr
```
public void setPhone2Descr(java.lang.String value)
```
    Sets the site's phone number 2 description.
    
    Parameters:
    
    value - (String) The phone number 2 description.
  - getPhone2
```
public java.lang.String getPhone2()
```
    Returns the site's phone number 2.
    
    Returns:
    
    String - The phone number 2.
  - setPhone2
```
public void setPhone2(java.lang.String value)
```
    Sets the site's phone number 2.
    
    Parameters:
    
    value - (String) The phone number 2.
  - getPhone3Descr
```
public java.lang.String getPhone3Descr()
```
    Returns the site's phone number 3 description.
    
    Returns:
    
    String - The phone number 3 description.
  - setPhone3Descr
```
public void setPhone3Descr(java.lang.String value)
```
    Sets the site's phone number 3 description.
    
    Parameters:
    
    value - (String) The phone number 3 description.
  - getPhone3
```
public java.lang.String getPhone3()
```
    Returns the site's phone number 3.
    
    Returns:
    
    String - The phone number 3.
  - setPhone3
```
public void setPhone3(java.lang.String value)
```
    Sets the site's phone number 3.
    
    Parameters:
    
    value - (String) The phone number 3.
  - getPhone4Descr
```
public java.lang.String getPhone4Descr()
```
    Returns the site's phone number 4 description.
    
    Returns:
    
    String - The phone number 4 description.
  - setPhone4Descr
```
public void setPhone4Descr(java.lang.String value)
```
    Sets the site's phone number 4 description.
    
    Parameters:
    
    value - (String) The phone number 4 description.
  - getPhone4
```
public java.lang.String getPhone4()
```
    Returns the site's phone number 4.
    
    Returns:
    
    String - The phone number 4.
  - setPhone4
```
public void setPhone4(java.lang.String value)
```
    Sets the site's phone number 4.
    
    Parameters:
    
    value - (String) The phone number 4.
  - getCorporateURL
```
public java.lang.String getCorporateURL()
```
    Returns the site's corporate web site url.
    
    Returns:
    
    String - The web site url.
  - setCorporateURL
```
public void setCorporateURL(java.lang.String value)
```
    Sets the site's corporate web site url.
    
    Parameters:
    
    value - (String) The web site url.
  - getAdmEmailName
```
public java.lang.String getAdmEmailName()
```
    Returns the site's administrator email name.
    
    Returns:
    
    String - The administrator email name.
  - setAdmEmailName
```
public void setAdmEmailName(java.lang.String value)
```
    Sets the site's administrator email name.
    
    Parameters:
    
    value - (String) The administrator email name.
  - getAdmEmailAddr
```
public java.lang.String getAdmEmailAddr()
```
    Returns the site's administrator email address.
    
    Returns:
    
    String - The administrator email address.
  - setAdmEmailAddr
```
public void setAdmEmailAddr(java.lang.String value)
```
    Sets the site's administrator email address.
    
    Parameters:
    
    value - (String) The administrator email address.
  - getSvcEmailName
```
public java.lang.String getSvcEmailName()
```
    Returns the site's customer service email name.
    
    Returns:
    
    String - The customer service email name.
  - setSvcEmailName
```
public void setSvcEmailName(java.lang.String value)
```
    Sets the site's customer service email name.
    
    Parameters:
    
    value - (String) The customer service email name.
  - getSvcEmailAddr
```
public java.lang.String getSvcEmailAddr()
```
    Returns the site's customer service email address.
    
    Returns:
    
    String - The customer service email address.
  - setSvcEmailAddr
```
public void setSvcEmailAddr(java.lang.String value)
```
    Sets the site's customer service email address.
    
    Parameters:
    
    value - (String) The customer service email address.
  - getSlsEmailName
```
public java.lang.String getSlsEmailName()
```
    Returns the site's sales email name.
    
    Returns:
    
    String - The sales email name.
  - setSlsEmailName
```
public void setSlsEmailName(java.lang.String value)
```
    Sets the site's sales email name.
    
    Parameters:
    
    value - (String) The sales email name.
  - getSlsEmailAddr
```
public java.lang.String getSlsEmailAddr()
```
    Returns the site's sales email address.
    
    Returns:
    
    String - The sales email address.
  - setSlsEmailAddr
```
public void setSlsEmailAddr(java.lang.String value)
```
    Sets the site's sales email address.
    
    Parameters:
    
    value - (String) The sales email address.

Class FlashSiteInfo

Field Summary

Fields inherited from class com.dpslink.base.obj.MappedAttributesObject

Constructor Summary

Method Summary

Methods inherited from class com.dpslink.base.obj.MappedAttributesObject

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

cvInstance

Constructor Detail

FlashSiteInfo

Method Detail

equals

instance

getAcronym

setAcronym

getFormalName

setFormalName

getCommonName

setCommonName

getAddress1

setAddress1

getAddress2

setAddress2

getAddress3

setAddress3

getAddress4

setAddress4

getPhone1Descr

setPhone1Descr

getPhone1

setPhone1

getPhone2Descr

setPhone2Descr

getPhone2

setPhone2

getPhone3Descr

setPhone3Descr

getPhone3

setPhone3

getPhone4Descr

setPhone4Descr

getPhone4

setPhone4

getCorporateURL

setCorporateURL

getAdmEmailName

setAdmEmailName

getAdmEmailAddr

setAdmEmailAddr

getSvcEmailName

setSvcEmailName

getSvcEmailAddr

setSvcEmailAddr

getSlsEmailName

setSlsEmailName

getSlsEmailAddr

setSlsEmailAddr