AbstractPropertyContext - JBOSS Portal 2.6 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.portlet.state
Class AbstractPropertyContext

java.lang.Object
  org.jboss.portal.portlet.state.AbstractPropertyContext

All Implemented Interfaces:: PropertyContext

public class AbstractPropertyContext
extends java.lang.Object
implements PropertyContext

Version:: $Revision: 5448 $
Author:: Julien Viet

Field Summary

private AccessMode access
          The access mode.

static int NO_CHANGE
          No change have been done or attempted.

private PreferencesInfo portletPrefs
          The runtime preferences info for the system.

private PropertyMap prefs
          The user prefs.

private int status
          State change status.

static int UPDATE_FAILED
          Attempts to update the state that failed has been performed.

static int UPDATE_SUCCESSFUL
          The state has been succesfully updated.

Constructor Summary

AbstractPropertyContext(AccessMode access, PropertyMap userPrefs, PreferencesInfo portletPrefs)
          Create a new object.

Method Summary

java.util.Set getKeys()
          Return the key set.

java.util.Set getPortletKeys()
          Return the key set.

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

PropertyMap getPrefs()


int getStatus()


Value getValue(java.lang.String key)
          Return for a specified key its value or null if the value does not exist.

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

boolean isReadOnly()
          Return true if the preferences are read only.

void update(PropertyChange[] changes)
          Update the preferences.

Methods inherited from class java.lang.Object

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

Field Detail

NO_CHANGE

public static final int NO_CHANGE

No change have been done or attempted.

See Also:: Constant Field Values

UPDATE_FAILED

public static final int UPDATE_FAILED

Attempts to update the state that failed has been performed.

See Also:: Constant Field Values

UPDATE_SUCCESSFUL

public static final int UPDATE_SUCCESSFUL

The state has been succesfully updated.

See Also:: Constant Field Values

prefs

private PropertyMap prefs

The user prefs.

portletPrefs

private PreferencesInfo portletPrefs

The runtime preferences info for the system.

access

private AccessMode access

The access mode.

status

private int status

State change status.

Constructor Detail

AbstractPropertyContext

public AbstractPropertyContext(AccessMode access,
                               PropertyMap userPrefs,
                               PreferencesInfo portletPrefs)
                        throws java.lang.IllegalArgumentException

Create a new object. If the userPrefs argument is null then the object is considered as globally read only.
Parameters:: userPrefs - the user prefs; portletPrefs - the portlet prefs
Throws:: java.lang.IllegalArgumentException - if the portletPrefs are null

Method Detail