com.businessobjects.sdk.plugin.desktop.common
Interface IActualConfigProperty

public interface IActualConfigProperty

This interface represents an individual property in the IActualConfigProperties collection.

Method Summary

java.lang.Object	getBadValue() For internal use only.
java.lang.Integer	getConstructorArgIndex() For internal use only.
java.lang.String	getDescription(java.util.Locale locale) Returns a localized description.
java.lang.String	getDisplayName(java.util.Locale locale) Returns the localized display name.
java.lang.Integer	getErrorId() For internal use only.
java.lang.String	getErrorString(java.util.Locale locale) Returns the localized error message.
java.lang.Integer	getGroup() For internal use only.
java.lang.String	getName() Returns the name of this configuration property.
java.lang.Integer	getOrder() For internal use only.
boolean	getRequiresRestart() Returns whether it is necessary to restart after the configuration property is modified.
IValidRanges	getValidRanges() Returns the valid ranges that are set for the value of this configuration property.
IValidValues	getValidValues() Returns the values that are allowed for this configuration property.
java.lang.Object	getValue() Returns the value that is being used by the server for this property.
boolean	hasValidRanges() Identifies if this configuration property has valid ranges.
boolean	hasValidValues() Identifies if this configuration property has valid values.
boolean	isFinal() Returns whether the value of this configuration property has been marked as final, or read-only.
boolean	isOverridden() Returns whether the value of this configuration property has been modified from the original (factory default) value.
boolean	isValueAccepted() Returns whether this property value can be accepted as is.

Method Detail

getValue

java.lang.Object getValue()

Returns the value that is being used by the server for this property.

Returns:

Object containing the value of this configuration property.

isOverridden

boolean isOverridden()

Returns whether the value of this configuration property has been modified from the original (factory default) value.

Returns:

Boolean true if the value has been modified, false otherwise.

isFinal

boolean isFinal()

Returns whether the value of this configuration property has been marked as final, or read-only.

Returns:

boolean true if the value is final, false otherwise.

getName

java.lang.String getName()

Returns the name of this configuration property.

Returns:

String containing the name of this configuration property.

getErrorId

java.lang.Integer getErrorId()

For internal use only.

getBadValue

java.lang.Object getBadValue()

For internal use only.

hasValidRanges

boolean hasValidRanges()

Identifies if this configuration property has valid ranges.

Returns:

boolean true if this property has a list of valid ranges, false otherwise.

getValidRanges

IValidRanges getValidRanges()

Returns the valid ranges that are set for the value of this configuration property.

Returns:

IValidRanges containing the list of valid ranges for the value of this configuration property.

hasValidValues

boolean hasValidValues()

Identifies if this configuration property has valid values.

Returns:

boolean true if this property has a list of valid values, false otherwise.

getValidValues

IValidValues getValidValues()

Returns the values that are allowed for this configuration property.

Returns:

IValidValues The list of valid values for this configuration property.

getRequiresRestart

boolean getRequiresRestart()

Returns whether it is necessary to restart after the configuration property is modified. If true, then the server must be restarted for the change to take effect.

getOrder

java.lang.Integer getOrder()

For internal use only.

getGroup

java.lang.Integer getGroup()

For internal use only.

getConstructorArgIndex

java.lang.Integer getConstructorArgIndex()

For internal use only.

getDisplayName

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

Returns the localized display name. If an exact match does not exist for the localized string, a fallback procedure will be performed to provide an alternative localized display name.

Parameters:

locale - The locale desired for the display name.

Returns:

String containing the localized display name.

Throws:

SDKException - if there are no display names available.

getDescription

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

Returns a localized description.

Parameters:

locale - The locale of the description.

Returns:

String containing the localized description.

Throws:

SDKException - if there are no descriptions available.

getErrorString

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

Returns the localized error message.

Parameters:

locale - The locale desired for the error message.

Returns:

String A localized error message.

isValueAccepted

boolean isValueAccepted()

Returns whether this property value can be accepted as is. This means there is no expectation for this property value to have the same value as the corresponding IConfigProperty.

Returns:

true if the value is to be accepted as is, false otherwise.