com.sap.netweaver.bc.rf.common.property.stringtype

Class StringSingleValueProperty

java.lang.Object
  com.sap.netweaver.bc.rf.common.property.AbstractProperty
      com.sap.netweaver.bc.rf.common.property.stringtype.StringSingleValueProperty

All Implemented Interfaces:

IProperty, Serializable

Direct Known Subclasses:

MutableStringSingleValueProperty, StringSingleValueProperty

public class StringSingleValueProperty
extends AbstractProperty

Class implementing a String single value property. See IProperty and IMutableProperty for details on properties

See Also:

AbstractProperty, IMutableProperty, IProperty, Serialized Form

Field Summary

protected String

value

Fields inherited from class com.sap.netweaver.bc.rf.common.property.AbstractProperty

attributes, flags, name, resourceBundles

Constructor Summary

StringSingleValueProperty(IPropertyName name, String value)
Construct property instance based on its internals.

StringSingleValueProperty(IPropertyName name, String value, int flags)
Construct property instance based on its internals.

StringSingleValueProperty(IPropertyName name, String value, Properties attributes)
Construct property instance based on its internals.

StringSingleValueProperty(IPropertyName name, String value, Properties attributes, int flags)
Construct property instance based on its internals.

StringSingleValueProperty(IPropertyName name, String value, Properties attributes, int flags, ResourceBundles resourceBundles)
Construct property instance based on its internals.

Method Summary

PropertyType	getType() Get immutable type of this property.
String	getValue() Get property value.
String	getValueAsString() Get the property value converted to a string.
String[]	getValuesAsStrings() Get the property values converted to a string array.
boolean	isMultiValue() Returns true if this property is a multi-value property.

Methods inherited from class com.sap.netweaver.bc.rf.common.property.AbstractProperty

areFlagsSet, equals, getAttribute, getAttributes, getDescription, getDescription, getFlags, getPropertyName, hashCode, isHidden, isLive, isReadOnly, isRequired, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

value

protected String value

Constructor Detail

StringSingleValueProperty

public StringSingleValueProperty(IPropertyName name,
                                 String value)
                          throws ResourceException

Construct property instance based on its internals.

Parameters:

name - property name

value - property value

Throws:

ResourceException - when the property creation failed

StringSingleValueProperty

public StringSingleValueProperty(IPropertyName name,
                                 String value,
                                 Properties attributes)
                          throws ResourceException

Construct property instance based on its internals.

Parameters:

name - property name

value - property value

attributes - property attributes

Throws:

ResourceException - when the property creation failed

StringSingleValueProperty

public StringSingleValueProperty(IPropertyName name,
                                 String value,
                                 int flags)
                          throws ResourceException

Construct property instance based on its internals.

Parameters:

name - property name

value - property value

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

Throws:

ResourceException - when the property creation failed

StringSingleValueProperty

public StringSingleValueProperty(IPropertyName name,
                                 String value,
                                 Properties attributes,
                                 int flags)
                          throws ResourceException

Construct property instance based on its internals.

Parameters:

name - property name

value - property value

attributes - property attributes

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

Throws:

ResourceException - when the property creation failed

StringSingleValueProperty

public StringSingleValueProperty(IPropertyName name,
                                 String value,
                                 Properties attributes,
                                 int flags,
                                 ResourceBundles resourceBundles)
                          throws ResourceException

Construct property instance based on its internals.

Parameters:

name - property name

value - property value

attributes - property attributes

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

resourceBundles - resource bundles containing (localized) property description

Throws:

ResourceException - when the property creation failed

Method Detail

getType

public PropertyType getType()

Get immutable type of this property.

Returns:

immutable type of this property

isMultiValue

public boolean isMultiValue()

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

Returns:

true if this property is a multi-value property

getValueAsString

public 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 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

getValue

public String getValue()

Get property value.

Returns:

property value

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM