com.sap.netweaver.bc.rf.common.property
Interface IProperty

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.common_api.jar]

All Known Subinterfaces:

IMutableProperty

All Known Implementing Classes:

AbstractProperty

public interface IProperty

Read-Only interface describing a property, which is part of the resource and describes certain aspects of it. A property has a name (IPropertyName), type (PropertyType), some attributes, a natural language description and most important a value. For each type exists a specific property interface and implementation extending this interface.

See Also:

IPropertyName, PropertyType, IMutableProperty

Method Summary

boolean	areFlagsSet() Return true if the internal system attributes are set.
java.lang.String	getAttribute(java.lang.String attributeName) Get attribute for the property.
java.util.Properties	getAttributes() Get all attributes for the property at once.
java.lang.String	getDescription() Get description of property.
java.lang.String	getDescription(java.util.Locale locale) Get localized description of property.
int	getFlags() Get bit array holding internal system attributes according to PropertyFlags bit mask fields.
IPropertyName	getPropertyName() Get immutable name of this property.
PropertyType	getType() Get immutable type of this property.
java.lang.String	getValueAsString() Get the property value converted to a string.
java.lang.String[]	getValuesAsStrings() Get the property values converted to a string array.
boolean	isHidden() Returns true if this property is hidden.
boolean	isLive() Returns true if this property is live.
boolean	isMultiValue() Returns true if this property is a multi-value property.
boolean	isReadOnly() Returns true if this property is read only.
boolean	isRequired() Returns true if this property is required.

Method Detail

getPropertyName

public IPropertyName getPropertyName()

Get immutable name of this property.

Returns:

immutable name of this property

getType

public PropertyType getType()

Get immutable type of this property.

Returns:

immutable type of this property

areFlagsSet

public boolean areFlagsSet()

Return true if the internal system attributes are set.

Returns:

true if the internal system attributes are set

getFlags

public int getFlags()

Get bit array holding internal system attributes according to PropertyFlags bit mask fields.

Returns:

bit array holding internal system attributes according to PropertyFlags bit mask fields

isMultiValue

public boolean isMultiValue()

Returns true if this property is a multi-value property.

Returns:

true if this property is a multi-value property

isRequired

public boolean isRequired()

Returns true if this property is required.

Returns:

true if this property is required

isLive

public boolean isLive()

Returns true if this property is live.

Returns:

true if this property is live

isReadOnly

public boolean isReadOnly()

Returns true if this property is read only.

Returns:

true if this property is read only

isHidden

public boolean isHidden()

Returns true if this property is hidden.

Returns:

true if this property is hidden

getDescription

public java.lang.String getDescription()

Get description of property. Usually the description will be looked up in a resource bundle using the property name as key. If no resource bundle is provided, the property name may be returned.

Returns:

description of property

getDescription

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

Get localized description of property. Usually the localized description will be looked up in a resource bundle using the property name as key. If no resource bundle is provided, the property name may be returned.

Parameters:

locale - locale to be used for localization

Returns:

localized description of property

getAttributes

public java.util.Properties getAttributes()
                                   throws ResourceException

Get all attributes for the property at once. The returned attribute map will be the stored one (as is - without being copied). Note that the stored attribute map is no longer connected to the property when it is set by a setAttributes() call.

Returns:

property map holding all attributes

Throws:

ResourceException - when the property is invalid

getAttribute

public java.lang.String getAttribute(java.lang.String attributeName)
                              throws ResourceException

Get attribute for the property.

Parameters:

attributeName - attribute name

Returns:

attribute value

Throws:

ResourceException - when the attribute name or the property is invalid

getValueAsString

public java.lang.String getValueAsString()
                                  throws ResourceException

Get the property value converted to a string. If this is a multi value property just return the first value.

Returns:

property value converted to a string

Throws:

ResourceException - when the property is invalid

getValuesAsStrings

public java.lang.String[] getValuesAsStrings()
                                      throws ResourceException

Get the property values converted to a string array. If this is a single value property just return an array with the value as only element.

Returns:

array of property values converted to strings

Throws:

ResourceException - when the property is invalid