com.sap.workspaces.module.settings.property

Interface IBaseModuleProperty

All Known Subinterfaces:

IModuleProperty, IModulePropertyAttribute, IModulePropertyValue

public interface IBaseModuleProperty

Represents a basic module property.

Method Summary

IModulePropertyAttribute	getAttribute(String attributeID) Returns the specified attribute of the property.
IModulePropertyAttribute[]	getAttributes() Return all attributes of the property.
String	getDescription() Returns the description of the property
String	getID() Returns the ID of the property
String	getName() Returns the property name
String	getValue() Returns the value of the property.
boolean	isReadOnly() Determines whether this property is read-only or not.
void	setValue(String value) Defines the value of the property.

Method Detail

getID

String getID()

Returns the ID of the property

Returns:

ID the of the property

getName

String getName()

Returns the property name

Returns:

the name of the property

getDescription

String getDescription()

Returns the description of the property

Returns:

the description of the property

isReadOnly

boolean isReadOnly()

Determines whether this property is read-only or not.

Returns:

true if this property is read-only, false otherwise

getAttribute

IModulePropertyAttribute getAttribute(String attributeID)

Returns the specified attribute of the property. If no attribute found return null.

Parameters:

attributeID - the ID of the attribute

Returns:

the specified attribute

getAttributes

IModulePropertyAttribute[] getAttributes()

Return all attributes of the property.

Returns:

all attributes of the property

getValue

String getValue()

Returns the value of the property.

Returns:

the value of the property

setValue

void setValue(String value)

Defines the value of the property.

Parameters:

value - new value for the property