Preferences - 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.common.prefs
Interface Preferences

All Superinterfaces:: ValueMap

All Known Subinterfaces:: ComponentPreferences, PortletPreferences

All Known Implementing Classes:: ComponentPreferencesPlugin, MapPreferences, PortletPreferencesPlugin

public interface Preferences
extends ValueMap

Extend the value map interface to provide meta information.

Method Summary

boolean isReadOnly(java.lang.String key)
Return the read only value for the given preference.

void setReadOnly(java.lang.String key, boolean readOnly)
Update the read only value for the given key.

Methods inherited from interface org.jboss.portal.common.value.ValueMap

getKeys, getValue, setValue

Method Detail

isReadOnly

public boolean isReadOnly(java.lang.String key)
                   throws java.lang.IllegalArgumentException

Return the read only value for the given preference.

Parameters:: key - the requested key
Returns:: the read only value
Throws:: java.lang.IllegalArgumentException - if the key is null

setReadOnly

public void setReadOnly(java.lang.String key,
                        boolean readOnly)
                 throws java.lang.IllegalArgumentException,
                        java.lang.UnsupportedOperationException

Update the read only value for the given key. Implementation can throw an unsupported operation exception when it is abnormal to perform an update.

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