com.goldencode.p2j.ui

Interface KeyValueStorage

All Known Subinterfaces:

ClientExports, ClientStorage

All Known Implementing Classes:

ClientStorageImpl, LocalStorageAccessor, ThinClient, UserPreferences

public interface KeyValueStorage

This interface defines access methods for a key value storage.

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String key) Deletes the given key and its value from this storage.
java.lang.Boolean	getBoolean(java.lang.String key) Retrieves the boolean value of the given key from this storage.
java.lang.Number	getNumber(java.lang.String key) Retrieves the number value of the given key from this storage.
java.lang.String	getStorageId() Returns the storage id for the logged in user.
java.lang.String	getString(java.lang.String key) Retrieves the string value of the given key from this storage.
void	setBoolean(java.lang.String key, java.lang.Boolean value) Saves the boolean value of this key in this storage.
void	setNumber(java.lang.String key, java.lang.Number value) Saves the number value of this key in this storage.
void	setString(java.lang.String key, java.lang.String value) Saves the string value of this key in this storage.

Method Detail

getNumber

java.lang.Number getNumber(java.lang.String key)

Retrieves the number value of the given key from this storage.

Parameters:

key - The given key

Returns:

The number value of the given key

setNumber

void setNumber(java.lang.String key,
               java.lang.Number value)

Saves the number value of this key in this storage.

Parameters:

key - The given key

value - The value of the given key

Throws:

ErrorConditionException - An exception from localStorage

getBoolean

java.lang.Boolean getBoolean(java.lang.String key)

Retrieves the boolean value of the given key from this storage.

Parameters:

key - The given key

Returns:

The boolean value of the given key

setBoolean

void setBoolean(java.lang.String key,
                java.lang.Boolean value)

Saves the boolean value of this key in this storage.

Parameters:

key - The given key

value - The value of the given key

Throws:

ErrorConditionException - An exception from localStorage

getString

java.lang.String getString(java.lang.String key)

Retrieves the string value of the given key from this storage.

Parameters:

key - The given key

Returns:

The string value of the given key

setString

void setString(java.lang.String key,
               java.lang.String value)

Saves the string value of this key in this storage.

Parameters:

key - The given key

value - The value of the given key

Throws:

ErrorConditionException - An exception from localStorage

delete

void delete(java.lang.String key)

Deletes the given key and its value from this storage.

Parameters:

key - The given key

getStorageId

java.lang.String getStorageId()

Returns the storage id for the logged in user. Available with SSO enabled.

Returns:

The storage id for the logged in user.