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

All Superinterfaces:

java.util.Collection, ISDKList, java.lang.Iterable, java.util.List

public interface IValidValues
extends ISDKList

This collection is used to store the values that are allowed in a configuration property.

Method Summary

boolean	add(java.lang.Object value) Adds a valid value to the collection.
boolean	contains(java.lang.Object localizedValue, java.util.Locale l) Determines whether a specific value is valid given the specified locale
java.lang.Object	getNonLocalizedValue(java.lang.Object localizedValue, java.util.Locale l) For the given value and specified locale, return the value that should actually be stored in the configuration property.
java.util.Iterator	iterator(java.util.Locale desiredLocale) Return a list of possible values that can be seen by an end-user.
boolean	remove(java.lang.Object value) Removes the specified value from the collection.

Methods inherited from interface com.crystaldecisions.sdk.properties.ISDKList

get

Methods inherited from interface java.util.List

add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Method Detail

add

boolean add(java.lang.Object value)

Adds a valid value to the collection. Only supported for values that are not localizable.

Specified by:

add in interface java.util.Collection

Specified by:

add in interface java.util.List

Parameters:

value - The value to add to the collection.

Returns:

true if the value is successfully added, false otherwise.

remove

boolean remove(java.lang.Object value)

Removes the specified value from the collection. Only supported for values that are not localizable.

Specified by:

remove in interface java.util.Collection

Specified by:

remove in interface java.util.List

Parameters:

value - The value to remove from the collection.

Returns:

true if the value is successfully removed, false otherwise.

iterator

java.util.Iterator iterator(java.util.Locale desiredLocale)

Return a list of possible values that can be seen by an end-user. These values should not be stored in the actual configuration property. Instead, the actual value () should be used instead.

Parameters:

desiredLocale - the locale of the localized values you wish to receive

Returns:

an iterator that can be used to iterate through the localized values

Since:

4.0

getNonLocalizedValue

java.lang.Object getNonLocalizedValue(java.lang.Object localizedValue,
                                      java.util.Locale l)

For the given value and specified locale, return the value that should actually be stored in the configuration property.

Parameters:

localizedValue - the localized value of an object

l - the locale the localized value is in

Returns:

the non-localized value

Since:

4.0

contains

boolean contains(java.lang.Object localizedValue,
                 java.util.Locale l)

Determines whether a specific value is valid given the specified locale

Parameters:

localizedValue - the localized value of an object

l - the locale the localized value is in

Returns:

true if it exists; false otherwise

Since:

4.0