com.softwareag.cis.plugin.table

Interface PropertyAccessor

public interface PropertyAccessor

Capsulates API for accessing properties of an Item

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription(java.util.Locale locale) Obtain a description which can be used by a tooltip for example
java.lang.String	getDisplayName(java.util.Locale locale) Obtain a localized display name for the property accessed using this PropertyAccessor
java.lang.String	getPropertyName() Obtain name of property being accessed via this accessor.
java.lang.String	getValue(Item item) Get value of property for given Item
boolean	isReadOnly() Check whether accessor allows for read access only
void	setValue(Item item, java.lang.String value) Set value of property for given Item

Method Detail

getPropertyName

java.lang.String getPropertyName()

Obtain name of property being accessed via this accessor.

Returns:

The string being returned is an internal string NOT being constructed by means of I18N infrastructure. It may be used internally for storing user-specific settings for example selected columns in a table. This selection should not depend on the language!

getDisplayName

java.lang.String getDisplayName(java.util.Locale locale)

Obtain a localized display name for the property accessed using this PropertyAccessor

Returns:

the localized display name

getDescription

java.lang.String getDescription(java.util.Locale locale)

Obtain a description which can be used by a tooltip for example

Returns:

a localized string of null, if no tooltip to be displayed

getValue

java.lang.String getValue(Item item)
                   throws java.lang.Exception

Get value of property for given Item

Throws:

java.lang.Exception

setValue

void setValue(Item item,
              java.lang.String value)
       throws java.lang.Exception

Set value of property for given Item

Throws:

java.lang.Exception

isReadOnly

boolean isReadOnly()

Check whether accessor allows for read access only