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

public interface IConfigProperty

This interface represents an individual property in the IConfigProperties collection.

Method Summary

void	clearErrorInfo() For internal use only.
java.lang.Object	getBadValue() For internal use only.
java.lang.Integer	getConstructorArgIndex() For internal use only.
boolean	getDefaultable() Returns whether the value of this property can be set to the default value defined on the associated service or service container.
java.lang.Object	getDefaultValue() 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.
IEnabledValues	getEnabledValues() For internal use only.
java.lang.String[]	getEnabler() For internal use only.
java.lang.Integer	getErrorId() For internal use only.
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	getPersists()
boolean	getRequiresRestart() Returns whether the server needs to be restarted for changes to the configuration property to take effect.
IValidRanges	getValidRanges() Returns the valid ranges that are set for the value of this configuration property.
IValidValues	getValidValues() Returns the values that are acceptable for this configuration property.
java.lang.Object	getValue() Returns the value of this configuration property.
boolean	hasValidRanges() Returns whether 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 (read-only).
boolean	isOverridden() Returns whether the value of this configuration property has been modified from the out-of-box (factory default) setting.
boolean	isVisible() Returns whether the value of this configuration property is visible.
void	setConstructorArgIndex(java.lang.Integer index) For internal use only.
void	setDefaultable(boolean defaultable) Sets whether the value of this property can be set to the default value defined on the associated service or service container.
void	setDescription(java.lang.String description, java.util.Locale locale) Sets a localized description.
void	setDisplayName(java.lang.String name, java.util.Locale locale) Sets a localized display name.
void	setErrorInfo(java.lang.Object badValue, int errorResId) For internal use only.
void	setFinal(boolean isFinal) Sets whether the value of this configuration property has been marked as final (read-only).
void	setName(java.lang.String name) Sets the name of this configuration property.
void	setPersists(boolean persists) For internal use only.
IConfigProperties	setPropertiesValue() Sets the value of this configuration property to a collection.
void	setRequiresRestart(boolean requiresRestart) Sets whether the server needs to be restarted for changes to this configuration property to take effect.
void	setValue(java.lang.Object val) Sets the value of this configuration property.
void	setValue(java.lang.Object val, java.util.Locale locale) Sets the value of this configuration property.
void	setVisible(boolean isVisible) Sets whether the value of this configuration property is visible.

Method Detail

getValue

java.lang.Object getValue()

Returns the value of this configuration property.

Returns:

Object containing the value of this property.

setValue

void setValue(java.lang.Object val)
              throws SDKException

Sets the value of this configuration property.

Parameters:

val - The value to set for this configuration property.

Throws:

SDKException - in the following situations:

• The configuration property is set as final.
• The type of the new value does not match the type of the current value.
• The configuration property has valid ranges or valid values and the new value does not match them.

setValue

void setValue(java.lang.Object val,
              java.util.Locale locale)
              throws SDKException

Sets the value of this configuration property.

Parameters:

val - The value to set for this configuration property.

locale - The locale the value is in

Throws:

SDKException - in the following situations:

• The configuration property is set as final.
• The type of the new value does not match the type of the current value.
• The configuration property has valid ranges or valid values and the new value does not match them.

Since:

4.0

setPropertiesValue

IConfigProperties setPropertiesValue()

Sets the value of this configuration property to a collection. Use the return value of this method to assign configuration property values.

Returns:

the configuration properties collection representing the value.

isOverridden

boolean isOverridden()

Returns whether the value of this configuration property has been modified from the out-of-box (factory default) setting.

Returns:

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 (read-only).

Returns:

true if the value is final, false otherwise.

setFinal

void setFinal(boolean isFinal)

Sets whether the value of this configuration property has been marked as final (read-only).

Parameters:

isFinal - set to true to set the value as final, false otherwise.

isVisible

boolean isVisible()

Returns whether the value of this configuration property is visible.

Returns:

true if the value is visible.

setVisible

void setVisible(boolean isVisible)

Sets whether the value of this configuration property is visible.

Parameters:

isVisible - set to true to set the value as visiable, false otherwise

getName

java.lang.String getName()

Returns the name of this configuration property.

Returns:

String The name of this configuration property.

setName

void setName(java.lang.String name)

Sets the name of this configuration property.

Parameters:

name - The name for this configuration property.

setErrorInfo

void setErrorInfo(java.lang.Object badValue,
                  int errorResId)

For internal use only.

clearErrorInfo

void clearErrorInfo()

For internal use only.

getErrorId

java.lang.Integer getErrorId()

For internal use only.

getBadValue

java.lang.Object getBadValue()

For internal use only.

hasValidRanges

boolean hasValidRanges()

Returns whether 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 valid ranges for this configuration property.

hasValidValues

boolean hasValidValues()

Identifies if this configuration property has valid values.

Returns:

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

getValidValues

IValidValues getValidValues()

Returns the values that are acceptable for this configuration property.

Returns:

IValidValues The list of valid values for this configuration property.

getRequiresRestart

boolean getRequiresRestart()

Returns whether the server needs to be restarted for changes to the configuration property to take effect.

Returns:

boolean true to be restarted, false otherwise.

setRequiresRestart

void setRequiresRestart(boolean requiresRestart)

Sets whether the server needs to be restarted for changes to this configuration property to take effect.

Parameters:

requiresRestart - true if the server needs to be restarted, false otherwise.

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.

setConstructorArgIndex

void setConstructorArgIndex(java.lang.Integer index)

For internal use only.

getPersists

boolean getPersists()

Returns:

true if property is persistent, false otherwise, including when the property has not been set.

setPersists

void setPersists(boolean persists)

For internal use only.

getDisplayName

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

Returns the localized display name.

If a display name does not exist for the specified locale, it will attempt to locate a suitable alternative. First, it will try to locate a display name in a similar locale (same language code). If none exists, it will try to locate a display name for an English locale. If none exists, it will use the first available display name.

Parameters:

locale - the locale 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.

If a description does not exist for the specified locale, it will attempt to locate a suitable alternative. First, it will try to locate a description in a similar locale (same language code). If none exists, it will try to locate a description for an English locale. If none exists, it will use the first available description.

Parameters:

locale - the locale for the description

Returns:

String containing the localized description.

Throws:

SDKException - if there are no descriptions available.

getDefaultable

boolean getDefaultable()

Returns whether the value of this property can be set to the default value defined on the associated service or service container.

Returns:

true if it can be set to the default value on the associated service or service container.

setDefaultable

void setDefaultable(boolean defaultable)

Sets whether the value of this property can be set to the default value defined on the associated service or service container.

Parameters:

defaultable - true to allow property to be defaultable, false otherwise

setDisplayName

void setDisplayName(java.lang.String name,
                    java.util.Locale locale)

Sets a localized display name.

Parameters:

name - The localized name.

locale - The locale of the name.

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale)

Sets a localized description.

Parameters:

description - The localized description.

locale - The locale of the description.

getEnabler

java.lang.String[] getEnabler()

For internal use only.

getEnabledValues

IEnabledValues getEnabledValues()

For internal use only.

getDefaultValue

java.lang.Object getDefaultValue()

For internal use only.