org.jboss.portal.portlet.info
Interface PreferenceInfo

All Known Implementing Classes:

ContainerPreferenceInfo, PreferenceInfoSupport

public interface PreferenceInfo

Describes a Portlet preference.

Since:

2.4

Method Summary

Value	getDefaultValue() Return the default value or null if it cannot be determined.
LocalizedString	getDisplayName() Retrieves the localized display name of the described preference.
java.lang.String	getKey() Retrieves the key associated to the described preference.
java.lang.Boolean	isReadOnly() Return true if the preference is read-only, false otherwise or null if it cannot be determined.

Method Detail

getKey

public java.lang.String getKey()

Retrieves the key associated to the described preference.

Returns:

the key associated to the described preference.

getDisplayName

public LocalizedString getDisplayName()

Retrieves the localized display name of the described preference.

Returns:

the localized display name of the described preference.

See Also:

LocalizedString

isReadOnly

public java.lang.Boolean isReadOnly()

Return true if the preference is read-only, false otherwise or null if it cannot be determined.

Returns:

true if the described preference is read-only, false otherwise.

getDefaultValue

public Value getDefaultValue()

Return the default value or null if it cannot be determined.

Returns:

the default value