|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public ItemSet
Interface to a simple abstraction of a datamodel. This provides a base from which more sofisticated data models can be built.
Method Summary | |
---|---|
ItemSet |
setLocalizedItemValue(String itemName,
Object value,
String locale)
This method sets an item within the ItemSet, creates or replaces an existing entry as needed. |
ItemSet |
setItemValue(String itemName,
Object value,
Boolean readOnly)
Deprecated. please use setItemValue(itemName,value) readOnly is always false |
ItemSet |
setItemValue(String itemName,
Object value)
This method sets a nonlocalized value of an item within the ItemSet, creates or replaces an existing entry as needed. |
Object |
getLocalizedItemValue(String itemName,
String locale)
This method returns the value for the named item in the specified locale. |
ItemSet |
getItemValue(String itemName)
This method returns the nonlocalized value for the named item from the set. |
String[] |
getAllNames()
This method returns an array of Strings, providing the name of each item. |
ItemSet |
removeItem(String itemName)
Removes the named item from the set. |
ItemSet |
removeItemValue(String itemName)
Removes the non localized value of the item from the set. |
ItemSet |
removeLocalizedItemValue(String itemName,
String locale)
Removes the value of the item from the set for a specified locale. |
String[] |
getLocalesWithValues(String itemName)
The method returns an array of strings, each providing a locale where a value is defined. |
ItemSet |
clone()
Deprecated. not used |
Boolean |
isReadOnly(String itemName)
Deprecated. always return false |
Object |
getItemSetDescription()
Deprecated. not used |
String |
addListener(Function listener)
Deprecated. not used |
Boolean |
removeListener(String listenerId)
Deprecated. not used |
Method Detail |
---|
ItemSet setLocalizedItemValue(String itemName, Object value, String locale)
itemName
-
name of the item. Must never be null
.value
-
value of the item. Must never be null
.locale
-
specified locale. Must never be null
.
null
upon failure.ItemSet setItemValue(String itemName, Object value, Boolean readOnly)
itemName
-
name of the item. Must never be null
.value
-
value of the item. Must never be null
.readOnly
-
optional Boolean attribute to indicate this item is readOnly or not.Default value is false if this parameter is not provided.
null
upon failure.ItemSet setItemValue(String itemName, Object value)
itemName
-
name of the item. Must never be null
.value
-
value of the item. Must never be null
.
null
upon failure.Object getLocalizedItemValue(String itemName, String locale)
itemName
-
name of the item. Must never be null
.locale
-
specified locale. Must never be null
.
null
upon failure.ItemSet getItemValue(String itemName)
itemName
-
name of the item. Must never be null
.
null
upon failure.String[] getAllNames()
null
if the set contains no itemItemSet removeItem(String itemName)
itemName
-
name of the item that needs to be removed. Must never be null
.
null
upon failure.ItemSet removeItemValue(String itemName)
itemName
-
name of the item that needs to be removed. Must never be null
.
null
upon failure.ItemSet removeLocalizedItemValue(String itemName, String locale)
itemName
-
name of the item that needs to be removed. Must never be null
.locale
-
a specified locale. Must never be null
.
null
upon failure.String[] getLocalesWithValues(String itemName)
itemName
-
name of the item. Must never be null
.
ItemSet clone()
Boolean isReadOnly(String itemName)
itemName
-
name of the required Item. Must never be null
.
null
.Object getItemSetDescription()
null
.
null
.String addListener(Function listener)
listener
-
js function that should already be properly scoped. Must never be null
.
Boolean removeListener(String listenerId)
listenerId
-
listener id that's returned by the system when listener is added. Must never be null
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |