PreferencesContext - JBOSS Portal 2.2 API 英文版文档

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.portal.server.app.spi
Interface PreferencesContext

All Known Implementing Classes:: PortletController.PreferencesContextImpl

public interface PreferencesContext

Method Summary

java.util.Set getSystemKeys()
          Return the merged key set.

Value getSystemValue(java.lang.String key)
          Return for a key a value or null if no suitable value is found.

java.util.Set getUserKeys()
          Return the key set of the map.

Value getUserValue(java.lang.String key)
          Return for a key a value or null if no suitable value is found.

boolean isSystemReadOnly(java.lang.String key)
          Say if the key is marked as read only or not.

void setUserValue(java.lang.String key, Value value)
          Update the value of the given key.

Method Detail

getUserKeys

public java.util.Set getUserKeys()

Return the key set of the map.

getUserValue

public Value getUserValue(java.lang.String key)
                   throws java.lang.IllegalArgumentException

Return for a key a value or null if no suitable value is found.

Parameters:: key - the requested key
Returns:: the found value or null
Throws:: java.lang.IllegalArgumentException - if the key or the array is null

setUserValue

public void setUserValue(java.lang.String key,
                         Value value)
                  throws java.lang.IllegalArgumentException,
                         java.lang.UnsupportedOperationException

Update the value of the given key. If the value object is null it means that the entry must be removed. Implementation can throw an unsupported operation exception when it is abnormal to perform an update.

Parameters:: key - the key to update; value - the new value
Throws:: java.lang.UnsupportedOperationException - if the operation is not supported; java.lang.IllegalArgumentException - if the key is null

getSystemKeys

public java.util.Set getSystemKeys()
                            throws java.lang.IllegalArgumentException

Return the merged key set.

Returns:: the system key set
Throws:: java.lang.IllegalArgumentException - if the array is null

getSystemValue

public Value getSystemValue(java.lang.String key)
                     throws java.lang.IllegalArgumentException