Flash

java.lang.Object
- com.dpslink.flash.util.Flash

All Implemented Interfaces:

java.io.Serializable
```
public class Flash
extends java.lang.Object
implements java.io.Serializable
```
Defines constants for Flash properties values which cannot be changed unless the application server is stopped and restarted. Note that other unchangeable values are defined by the base Profile class.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CATEGORY_DESC_PATH` The full path to the category description folder per the configured values for "Site.Path" and "Category.Description".
`static java.lang.String`	`CATEGORY_IMG_PATH` The full path to the category image folder per the configured values for "Site.Path" and "Category.Image".
`static boolean`	`ONETIME_SHIPTO_ALL` The value of the "Customer.OneTimeShipto" key in properties.
`static boolean`	`ONETIME_SHIPTO_MIX` The value of the "Customer.OneTimeShipto" key in properties.
`static boolean`	`ONETIME_SHIPTO_NONE` The value of the "Customer.OneTimeShipto" key in properties.
`static boolean`	`PERMIT_CUSTID` The value of the "Product.Catalog.Permit.Active" key in properties.
`static boolean`	`PERMIT_ENABLED` The value of the "Product.Catalog.Permit.Active" key in properties.
`static boolean`	`PERMIT_SHIPID` The value of the "Product.Catalog.Permit.Active" key in properties.
`static boolean`	`PERMIT_USERID` The value of the "Product.Catalog.Permit.Active" key in properties.
`static java.lang.String`	`PRODUCT_DESC_PATH_LARGE` The full path to the product large description folder per the configured values for "Site.Path" and "Product.Description.Large".
`static java.lang.String`	`PRODUCT_DESC_PATH_SMALL` The full path to the product small description folder per the configured values for "Site.Path" and "Product.Description.Small".
`static boolean`	`PRODUCT_DESC_TRANSLATE` The configured flag for performing translation for description file names.
`static java.lang.String`	`PRODUCT_IMG_PATH_LARGE` The full path to the product large image folder per the configured values for "Site.Path" and "Product.Image.Large".
`static java.lang.String`	`PRODUCT_IMG_PATH_SMALL` The full path to the product small image folder per the configured values for "Site.Path" and "Product.Image.Small".
`static boolean`	`PRODUCT_IMG_TRANSLATE` The configured flag for performing translation for image file names.
`static boolean`	`PRODUCT_MULTIPLEUOM` The value of the "Product.MultipleUOM" key in properties.
`static boolean`	`REALTIME_AVAILABILITY` Determine if realtime stock availability is turned on
`static java.lang.String[]`	`REALTIME_EXCLUDE` A list of classes that are excluded from realtime pricing/availability.
`static boolean`	`REALTIME_PRICING` Determine if realtime pricing is turned on
`static boolean`	`REALTIME_PRICING_DFLT_USER` Determine if realtime pricing is turned on for the default user
`static boolean`	`SECURITY_ENCRYPT_CCNO` The value of the "Security.Encrypt.CreditCardNumbers" key in properties.
`static boolean`	`SECURITY_ENCRYPT_PWD` The value of the "Security.Encrypt.Passwords" key in properties.
`private static long`	`serialVersionUID` The class' serialization version id.
`static int`	`STORE_PRICE_DECIMALS` The value of the "Store.Price.Decimals" key in properties.
`static java.text.DecimalFormat`	`STORE_PRICE_FMT1` A formatter for unit price.
`static java.text.DecimalFormat`	`STORE_PRICE_FMT2` A formatter for unit price.
`static java.text.DecimalFormat`	`STORE_PRICE_FMT3` A formatter for unit price.
`static int`	`STORE_QTY_DECIMALS` The value of the "Store.Qty.Decimals" key in properties.
`static java.text.DecimalFormat`	`STORE_QTY_FMT1` A formatter for quantity.
`static java.text.DecimalFormat`	`STORE_QTY_FMT2` A formatter for quantity.
`static int`	`STORE_STOCK_LOWQTY` Default low stock quantity for a product
`static int`	`STORE_STOCK_OUTQTY` Default out of stock quantity for a product
`static int`	`STORE_TOTAL_DECIMALS` The value of the "Store.Total.Decimals" key in properties.
`static java.text.DecimalFormat`	`STORE_TOTAL_FMT1` A formatter for extended amount or total amount.
`static java.text.DecimalFormat`	`STORE_TOTAL_FMT2` A formatter for extended amount or total amount.
`static java.text.DecimalFormat`	`STORE_TOTAL_FMT3` A formatter for extended amount or total amount.
`static boolean`	`STORE_TOTAL_TRUNCATE` The value of the "Store.ExtendedAmt.Truncate" key in properties.
`static java.lang.String[]`	`USER_TYPE_CODES` The value of the "User.Type.Codes" key in properties.
`static java.lang.String[]`	`USER_TYPE_NAMES` The value of the "User.Type.Names" key in properties.

Constructor Summary

Constructors
Constructor and Description

Flash()

Constructors
Constructor and Description
`Flash()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`getAbsolutePath(java.lang.String key)` Returns the full path to the folder defined by the given properties key.
`private static void`	`modifyFormatter(java.text.DecimalFormat fmt, int decimals, boolean groups, boolean symbol, boolean useminus)` Modifies a decimal format's definition using the supplied parameters.

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

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    The class' serialization version id.
    
    See Also:
    
    Constant Field Values
  - CATEGORY_DESC_PATH
```
public static java.lang.String CATEGORY_DESC_PATH
```
    The full path to the category description folder per the configured values for "Site.Path" and "Category.Description". Includes trailing file separator character.
  - CATEGORY_IMG_PATH
```
public static java.lang.String CATEGORY_IMG_PATH
```
    The full path to the category image folder per the configured values for "Site.Path" and "Category.Image". Includes trailing file separator character.
  - ONETIME_SHIPTO_ALL
```
public static final boolean ONETIME_SHIPTO_ALL
```
    The value of the "Customer.OneTimeShipto" key in properties. Indicates if only one-time ship-tos are allowed and persisted ship-tos are never allowed (value == "ALL").
  - ONETIME_SHIPTO_NONE
```
public static final boolean ONETIME_SHIPTO_NONE
```
    The value of the "Customer.OneTimeShipto" key in properties. Indicates if one-time ship-tos are never allowed and only persisted ship-tos are allowed (value == "NONE").
  - ONETIME_SHIPTO_MIX
```
public static final boolean ONETIME_SHIPTO_MIX
```
    The value of the "Customer.OneTimeShipto" key in properties. Indicates if one-time ship-tos and persisted ship-tos are both allowed (value != "ALL" and value != "NONE"). A value of SOME or SELECT has hystorically been used for this scenario; however, any value other than ALL or NONE will give the same result.
  - PERMIT_ENABLED
```
public static final boolean PERMIT_ENABLED
```
    The value of the "Product.Catalog.Permit.Active" key in properties. Indicates if permit processing is enabled (value != "no").
  - PERMIT_CUSTID
```
public static final boolean PERMIT_CUSTID
```
    The value of the "Product.Catalog.Permit.Active" key in properties. Indicates if permit processing is by user's assigned customer id (value == "custid").
  - PERMIT_SHIPID
```
public static final boolean PERMIT_SHIPID
```
    The value of the "Product.Catalog.Permit.Active" key in properties. Indicates if permit processing is by user's shipto customer id (value == "shipid").
  - PERMIT_USERID
```
public static final boolean PERMIT_USERID
```
    The value of the "Product.Catalog.Permit.Active" key in properties. Indicates if permit processing is by user id (value == "userid") or (value == "yes").
  - PRODUCT_DESC_PATH_LARGE
```
public static java.lang.String PRODUCT_DESC_PATH_LARGE
```
    The full path to the product large description folder per the configured values for "Site.Path" and "Product.Description.Large". Includes trailing file separator character.
  - PRODUCT_DESC_PATH_SMALL
```
public static java.lang.String PRODUCT_DESC_PATH_SMALL
```
    The full path to the product small description folder per the configured values for "Site.Path" and "Product.Description.Small". Includes trailing file separator character.
  - PRODUCT_DESC_TRANSLATE
```
public static final boolean PRODUCT_DESC_TRANSLATE
```
    The configured flag for performing translation for description file names. ("Product.Description.Translate")
  - PRODUCT_IMG_PATH_LARGE
```
public static java.lang.String PRODUCT_IMG_PATH_LARGE
```
    The full path to the product large image folder per the configured values for "Site.Path" and "Product.Image.Large". Includes trailing file separator character.
  - PRODUCT_IMG_PATH_SMALL
```
public static java.lang.String PRODUCT_IMG_PATH_SMALL
```
    The full path to the product small image folder per the configured values for "Site.Path" and "Product.Image.Small". Includes trailing file separator character.
  - PRODUCT_IMG_TRANSLATE
```
public static final boolean PRODUCT_IMG_TRANSLATE
```
    The configured flag for performing translation for image file names. ("Product.Image.Translate")
  - PRODUCT_MULTIPLEUOM
```
public static final boolean PRODUCT_MULTIPLEUOM
```
    The value of the "Product.MultipleUOM" key in properties. Indicates if product multiple units of measure processing is active.
  - REALTIME_EXCLUDE
```
public static java.lang.String[] REALTIME_EXCLUDE
```
    A list of classes that are excluded from realtime pricing/availability. This gives us some fine grain control over when realtime data is obtained as opposed to the existing yes/no settings.
  - REALTIME_PRICING
```
public static boolean REALTIME_PRICING
```
    Determine if realtime pricing is turned on
  - REALTIME_PRICING_DFLT_USER
```
public static boolean REALTIME_PRICING_DFLT_USER
```
    Determine if realtime pricing is turned on for the default user
  - REALTIME_AVAILABILITY
```
public static boolean REALTIME_AVAILABILITY
```
    Determine if realtime stock availability is turned on
  - SECURITY_ENCRYPT_CCNO
```
public static final boolean SECURITY_ENCRYPT_CCNO
```
    The value of the "Security.Encrypt.CreditCardNumbers" key in properties.
  - SECURITY_ENCRYPT_PWD
```
public static final boolean SECURITY_ENCRYPT_PWD
```
    The value of the "Security.Encrypt.Passwords" key in properties.
  - STORE_PRICE_DECIMALS
```
public static final int STORE_PRICE_DECIMALS
```
    The value of the "Store.Price.Decimals" key in properties.
  - STORE_PRICE_FMT1
```
public static final java.text.DecimalFormat STORE_PRICE_FMT1
```
    A formatter for unit price. Includes currency symbol. Includes grouping separators.
  - STORE_PRICE_FMT2
```
public static final java.text.DecimalFormat STORE_PRICE_FMT2
```
    A formatter for unit price. Excludes currency symbol. Includes grouping separators.
  - STORE_PRICE_FMT3
```
public static final java.text.DecimalFormat STORE_PRICE_FMT3
```
    A formatter for unit price. Excludes currency symbol. Excludes grouping separators.
  - STORE_QTY_DECIMALS
```
public static final int STORE_QTY_DECIMALS
```
    The value of the "Store.Qty.Decimals" key in properties.
  - STORE_QTY_FMT1
```
public static final java.text.DecimalFormat STORE_QTY_FMT1
```
    A formatter for quantity. Includes grouping separators.
  - STORE_QTY_FMT2
```
public static final java.text.DecimalFormat STORE_QTY_FMT2
```
    A formatter for quantity. Excludes grouping separators.
  - STORE_STOCK_LOWQTY
```
public static final int STORE_STOCK_LOWQTY
```
    Default low stock quantity for a product
  - STORE_STOCK_OUTQTY
```
public static final int STORE_STOCK_OUTQTY
```
    Default out of stock quantity for a product
  - STORE_TOTAL_DECIMALS
```
public static final int STORE_TOTAL_DECIMALS
```
    The value of the "Store.Total.Decimals" key in properties.
  - STORE_TOTAL_FMT1
```
public static final java.text.DecimalFormat STORE_TOTAL_FMT1
```
    A formatter for extended amount or total amount. Includes currency symbol. Includes grouping separators.
  - STORE_TOTAL_FMT2
```
public static final java.text.DecimalFormat STORE_TOTAL_FMT2
```
    A formatter for extended amount or total amount. Excludes currency symbol. Includes grouping separators.
  - STORE_TOTAL_FMT3
```
public static final java.text.DecimalFormat STORE_TOTAL_FMT3
```
    A formatter for extended amount or total amount. Excludes currency symbol. Excludes grouping separators.
  - STORE_TOTAL_TRUNCATE
```
public static final boolean STORE_TOTAL_TRUNCATE
```
    The value of the "Store.ExtendedAmt.Truncate" key in properties. If set to "yes" an extended amount will be truncated rather than being rounded. Truncation and rounding are both per STORE_TOTAL_DECIMALS.
  - USER_TYPE_CODES
```
public static final java.lang.String[] USER_TYPE_CODES
```
    The value of the "User.Type.Codes" key in properties.
  - USER_TYPE_NAMES
```
public static final java.lang.String[] USER_TYPE_NAMES
```
    The value of the "User.Type.Names" key in properties.
- Constructor Detail
  - Flash
```
public Flash()
```
- Method Detail
  - getAbsolutePath
```
public static java.lang.String getAbsolutePath(java.lang.String key)
```
    Returns the full path to the folder defined by the given properties key. The value of the properties key is assumed to be a path that is relative to the site's root folder ("Site.Root"). The resulting folder path is checked for existence and is created if it does not already exist.
    
    Parameters:
    
    key - (String) The properties key for a folder's relative path.
    
    Returns:
    
    String - The full path to the folder. Includes trailing file separator character.
  - modifyFormatter
```
private static void modifyFormatter(java.text.DecimalFormat fmt,
                                    int decimals,
                                    boolean groups,
                                    boolean symbol,
                                    boolean useminus)
```
    Modifies a decimal format's definition using the supplied parameters.
    
    Parameters:
    
    fmt - (DecimalFormat) The format to modify.
    
    decimals - (int) The number of decimal positions.
    
    groups - (boolean) true if groupings separators are to be included, otherwise false.
    
    symbol - (boolean) true if the currency symbol is to be included, otherwise false. Note that this method will only remove the currency symbol from a format. It will not add a currency symbol.
    
    useminus - (boolean) true if negative numbers should be denoted with a trailing minus sign, otherwise false.

Class Flash

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

CATEGORY_DESC_PATH

CATEGORY_IMG_PATH

ONETIME_SHIPTO_ALL

ONETIME_SHIPTO_NONE

ONETIME_SHIPTO_MIX

PERMIT_ENABLED

PERMIT_CUSTID

PERMIT_SHIPID

PERMIT_USERID

PRODUCT_DESC_PATH_LARGE

PRODUCT_DESC_PATH_SMALL

PRODUCT_DESC_TRANSLATE

PRODUCT_IMG_PATH_LARGE

PRODUCT_IMG_PATH_SMALL

PRODUCT_IMG_TRANSLATE

PRODUCT_MULTIPLEUOM

REALTIME_EXCLUDE

REALTIME_PRICING

REALTIME_PRICING_DFLT_USER

REALTIME_AVAILABILITY

SECURITY_ENCRYPT_CCNO

SECURITY_ENCRYPT_PWD

STORE_PRICE_DECIMALS

STORE_PRICE_FMT1

STORE_PRICE_FMT2

STORE_PRICE_FMT3

STORE_QTY_DECIMALS

STORE_QTY_FMT1

STORE_QTY_FMT2

STORE_STOCK_LOWQTY

STORE_STOCK_OUTQTY

STORE_TOTAL_DECIMALS

STORE_TOTAL_FMT1

STORE_TOTAL_FMT2

STORE_TOTAL_FMT3

STORE_TOTAL_TRUNCATE

USER_TYPE_CODES

USER_TYPE_NAMES

Constructor Detail

Flash

Method Detail

getAbsolutePath

modifyFormatter