DominoPreferences (Domingo 1.5.2 API)

java.lang.Object
- de.jakop.lotus.domingo.http.DominoPreferences

public final class DominoPreferences
extends Object

Domino regional preferences.

Author:: Kurt Riede

Field Summary

Fields
Modifier and Type	Field and Description
`static DominoLocale`	`DEFAULT_LOCALE` The locale settings.
`static String`	`DEFAULT_TIME_ZONE` Default time zone search string.
`static String`	`ENCODING_UTF_8` Default encoding (UTF-8) for cookie values.
`static int`	`EXPIRY_YEARS` Number of years that a preferences cookie is valid.

Constructor Summary

Constructors
Constructor and Description

DominoPreferences(String domain)
Constructor.

DominoPreferences(String domain, String path)
Constructor.

Constructors
Constructor and Description
`DominoPreferences(String domain)` Constructor.
`DominoPreferences(String domain, String path)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.apache.commons.httpclient.Cookie`	`getRegionalCookie()` Returns a new Lotus Domino regional cookie.
`List`	`getRegionalCookies()` Returns a list of cookies for the current regional settings.
`org.apache.commons.httpclient.Cookie`	`getTimeZoneCookie()` Returns a new Lotus Domino time zone cookie.
`static String`	`implode(List stringList, String delimiter)` Combines the elements of a string array to a single string using a given seperator.
`void`	`setAmPmSuffix(boolean amPmSuffix)`
`void`	`setAmString(String amString)`
`void`	`setCookies(List cookies)`
`void`	`setCurrencySpace(boolean currencySpace)`
`void`	`setCurrencySymbol(String currencySymbol)`
`void`	`setDateSeperator(String dateSeperator)`
`void`	`setDecimalSeperator(String decimalSeperator)`
`void`	`setDst(boolean dst)`
`void`	`setHourFormat(boolean hour24Format)`
`void`	`setLeadingDecimalZeros(boolean leadingDecimalZeros)`
`void`	`setLocale(String locale)`
`void`	`setLocale(String localeString, boolean loadDefault)`
`void`	`setObserverDST(boolean dst)` Sets whether to observe daylight saving time or not.
`void`	`setPmString(String pmString)`
`void`	`setPositionCurrencySymbol(boolean currencySuffix)`
`void`	`setThousandsSeperator(String thousandsSeperator)`
`void`	`setTimeSeperator(String timeSeperator)`
`void`	`setTimeZone(DominoTimeZone timeZone)` Sets the time zone.
`String`	`toString()`

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

- Field Detail
  - EXPIRY_YEARS
```
public static final int EXPIRY_YEARS
```
    Number of years that a preferences cookie is valid.
    
    See Also:
    
    Constant Field Values
  - ENCODING_UTF_8
```
public static final String ENCODING_UTF_8
```
    Default encoding (UTF-8) for cookie values.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TIME_ZONE
```
public static final String DEFAULT_TIME_ZONE
```
    Default time zone search string.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LOCALE
```
public static final DominoLocale DEFAULT_LOCALE
```
    The locale settings.
- Constructor Detail
  - DominoPreferences
```
public DominoPreferences(String domain)
```
    Constructor.
    
    Parameters:
    
    domain - the domain to that this preferences belong to
  - DominoPreferences
```
public DominoPreferences(String domain,
                         String path)
```
    Constructor.
    
    Parameters:
    
    domain - the domain to that this preferences belong to
    
    path - the path defining the subset of URLs in a domain for which the cookie is valid
- Method Detail
  - setTimeZone
```
public void setTimeZone(DominoTimeZone timeZone)
```
    Sets the time zone.
    
    Parameters:
    
    timeZone - Domino time zone
  - setObserverDST
```
public void setObserverDST(boolean dst)
```
    Sets whether to observe daylight saving time or not.
    
    Parameters:
    
    dst - observe daylight saving time or not
  - setLocale
```
public void setLocale(String locale)
```
    Parameters:
    
    locale - The locale to set.
  - setLocale
```
public void setLocale(String localeString,
                      boolean loadDefault)
```
    Parameters:
    
    localeString - The locale to set as a string.
    
    loadDefault - if true, load all default values for this locale
  - setAmString
```
public void setAmString(String amString)
```
    Parameters:
    
    amString - The amString to set.
  - setCurrencySpace
```
public void setCurrencySpace(boolean currencySpace)
```
    Parameters:
    
    currencySpace - The currencySpace to set.
  - setCurrencySymbol
```
public void setCurrencySymbol(String currencySymbol)
```
    Parameters:
    
    currencySymbol - The currencySymbol to set.
  - setDateSeperator
```
public void setDateSeperator(String dateSeperator)
```
    Parameters:
    
    dateSeperator - The dateSeperator to set.
  - setDecimalSeperator
```
public void setDecimalSeperator(String decimalSeperator)
```
    Parameters:
    
    decimalSeperator - The decimalSeperator to set.
  - setCookies
```
public void setCookies(List cookies)
```
    Parameters:
    
    cookies - The cookies to set.
  - setDst
```
public void setDst(boolean dst)
```
    Parameters:
    
    dst - The dst to set.
  - setHourFormat
```
public void setHourFormat(boolean hour24Format)
```
    Parameters:
    
    hour24Format - The hourFormat to set.
  - setLeadingDecimalZeros
```
public void setLeadingDecimalZeros(boolean leadingDecimalZeros)
```
    Parameters:
    
    leadingDecimalZeros - The leadingDecimalZeros to set.
  - setPmString
```
public void setPmString(String pmString)
```
    Parameters:
    
    pmString - The pmString to set.
  - setAmPmSuffix
```
public void setAmPmSuffix(boolean amPmSuffix)
```
    Parameters:
    
    amPmSuffix - The amPmSuffix to set.
  - setPositionCurrencySymbol
```
public void setPositionCurrencySymbol(boolean currencySuffix)
```
    Parameters:
    
    currencySuffix - The currencySuffix to set.
  - setThousandsSeperator
```
public void setThousandsSeperator(String thousandsSeperator)
```
    Parameters:
    
    thousandsSeperator - The thousandsSeperator to set.
  - setTimeSeperator
```
public void setTimeSeperator(String timeSeperator)
```
    Parameters:
    
    timeSeperator - The timeSeperator to set.
  - getRegionalCookies
```
public List getRegionalCookies()
```
    Returns a list of cookies for the current regional settings.
    
    Returns:
    
    cookies for regional settings
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.
    
    See Also:
    
    Object.toString()
  - implode
```
public static String implode(List stringList,
                             String delimiter)
```
    Combines the elements of a string array to a single string using a given seperator.
    
    Parameters:
    
    stringList - a list of strings
    
    delimiter - the delimiting string
    
    Returns:
    
    combined string
  - getTimeZoneCookie
```
public org.apache.commons.httpclient.Cookie getTimeZoneCookie()
```
    Returns a new Lotus Domino time zone cookie.
    
    Returns:
    
    Lotus Domino time zone cookie
  - getRegionalCookie
```
public org.apache.commons.httpclient.Cookie getRegionalCookie()
```
    Returns a new Lotus Domino regional cookie.
    
    Returns:
    
    Lotus Domino regional cookie

Class DominoPreferences

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXPIRY_YEARS

ENCODING_UTF_8

DEFAULT_TIME_ZONE

DEFAULT_LOCALE

Constructor Detail

DominoPreferences

DominoPreferences

Method Detail

setTimeZone

setObserverDST

setLocale

setLocale

setAmString

setCurrencySpace

setCurrencySymbol

setDateSeperator

setDecimalSeperator

setCookies

setDst

setHourFormat

setLeadingDecimalZeros

setPmString

setAmPmSuffix

setPositionCurrencySymbol

setThousandsSeperator

setTimeSeperator

getRegionalCookies

toString

implode

getTimeZoneCookie

getRegionalCookie