lumis.portal.servicecontainer

Class RequestPreferences

java.lang.Object

lumis.portal.servicecontainer.RequestPreferences

All Implemented Interfaces:

PortletPreferences, IPreferences

public class RequestPreferences
extends Object
implements IPreferences

The preferences object returned by the ServiceContainerRequest.

Since:

4.0.7

Version:

$Revision: 20212 $ $Date: 2017-06-05 21:16:13 +0000 (Mon, 05 Jun 2017) $

Field Summary

Fields inherited from interface lumis.portal.preferences.IPreferences

TYPE_SERVICE_INTERFACE_INSTANCE

Constructor Summary

Constructors

Constructor and Description
RequestPreferences(ServiceContainerRequest request, IPreferences preferences)

Method Summary

Modifier and Type	Method and Description
String	getLocalValue(String key, String def) Returns the first String value associated with the specified key of this preference.
String[]	getLocalValues(String key, String[] def) Returns the String array value associated with the specified key in this preference.
Map	getMap()
Enumeration	getNames()
String	getValue(String key, String def)
String[]	getValues(String key, String[] def)
boolean	isReadOnly(String key)
void	reset(String key)
void	setValue(String key, String value)
void	setValues(String key, String[] values)
void	store()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RequestPreferences

public RequestPreferences(ServiceContainerRequest request,
                          IPreferences preferences)

Method Detail

getMap

public Map getMap()

Specified by:

getMap in interface PortletPreferences

getNames

public Enumeration getNames()

Specified by:

getNames in interface PortletPreferences

getValue

public String getValue(String key,
                       String def)

Specified by:

getValue in interface PortletPreferences

getValues

public String[] getValues(String key,
                          String[] def)

Specified by:

getValues in interface PortletPreferences

isReadOnly

public boolean isReadOnly(String key)

Specified by:

isReadOnly in interface PortletPreferences

reset

public void reset(String key)
           throws ReadOnlyException

Specified by:

reset in interface PortletPreferences

Throws:

ReadOnlyException

setValue

public void setValue(String key,
                     String value)
              throws ReadOnlyException

Specified by:

setValue in interface PortletPreferences

Throws:

ReadOnlyException

setValues

public void setValues(String key,
                      String[] values)
               throws ReadOnlyException

Specified by:

setValues in interface PortletPreferences

Throws:

ReadOnlyException

store

public void store()
           throws IOException,
                  ValidatorException

Specified by:

store in interface PortletPreferences

Throws:

IOException

ValidatorException

getLocalValue

public String getLocalValue(String key,
                            String def)

Description copied from interface: IPreferences

Returns the first String value associated with the specified key of this preference. This preference is read locally in the current preference level. If there is one or more preference values associated with the given key it returns the first local associated value. If there are no preference values associated with the given key, or the backing preference database is unavailable, it returns the given default value. A null value is treated as a non-existent value.

Specified by:

getLocalValue in interface IPreferences

Parameters:

key - key for which the associated value is to be returned

def - the value to be returned in the event that there is no value available associated with this key.

Returns:

the local value associated with key, or def if no value is associated with key, or the backing store is inaccessible. The value is read locally in the current preferences level.

See Also:

PortletPreferences.getValues(String, String[])

getLocalValues

public String[] getLocalValues(String key,
                               String[] def)

Description copied from interface: IPreferences

Returns the String array value associated with the specified key in this preference. This preference is read locally in the current preferences level.

Returns the specified default if there is no value associated with the key, or if the backing store is inaccessible. A null value is treated as a non-existent value.

If the implementation supports stored defaults and such a default exists and is accessible, it is used in favor of the specified default.

Specified by:

getLocalValues in interface IPreferences

Parameters:

key - key for which associated value is to be returned.

def - the value to be returned in the event that this preference node has no value associated with key or the associated value cannot be interpreted as a String array, or the backing store is inaccessible.

Returns:

the String array value associated with key, or def if the associated value does not exist. The value is read locally in the current preferences level.

See Also:

PortletPreferences.getValue(String,String)