public interface Data extends Iterable<DataValue>, MultiPageParamsProvider
Modifier and Type | Method and Description |
---|---|
DataValue |
create(String name,
UserService userService,
Element value)
Create a new
DataValue instance as child of this data object
initializing the child with the respective EditorValue . |
DataValue |
createDataValue(String name)
Create a new
DataValue object for the given name. |
DataValue |
get(int index)
Return DataValue specified by a index.
|
DataValue |
get(String name)
Get a data value object by its variable name.
|
GomEditorProvider |
getGomProvider()
Get the provider of the GUI structure for this data object.
|
MultiPageParams |
getMultiPageParams(Language language)
Deprecated.
Since 5.0.104, no replacement.
|
Reference[] |
getReferences()
Provides references within the data's values.
|
int |
getSize()
Get the number of available DataValue entries.
|
List<String> |
getVariableNames() |
boolean |
hasData()
Indicates that the data instance has any set value, i.e., there is at least one
DataValue where DataValue.getEditor().isSet() evaluates to
true . |
int |
indexOf(String name)
Return index of a named variable.
|
boolean |
isDefault()
Indicates, that this data object represents a default data
container.
|
boolean |
isMeta()
Indicates the data's source to represent meta information.
|
boolean |
isRelease()
Indicates the data's source is released.
|
boolean |
isValid()
Indicates, whether the data values are valid wrt. its GOM, e.g., if
all mandatory values are set.
|
Iterator<DataValue> |
iterator()
Iterates over available
DataValue 's. |
boolean |
remove(DataValue o)
Remove a single instance of the specified DataValue from the current Data-object
|
String |
toXml()
Get the XML-structure of the current Data-object
|
boolean remove(DataValue o)
o
- DataValue to be removed from the Data-object, if presentDataValue createDataValue(String name)
DataValue
object for the given name.name
- name of the new DataValueDataValue create(String name, UserService userService, @Nullable Element value) throws ClassCastException, InstantiationException, IllegalAccessException, ClassNotFoundException
DataValue
instance as child of this data object
initializing the child with the respective EditorValue
.name
- The name of the value.userService
- The user service to us.value
- The parsed DataValue element (maybe null).ClassCastException
- If creating the data value went wrong.ClassNotFoundException
- If creating the data value went wrong.IllegalAccessException
- If creating the data value went wrong.InstantiationException
- If creating the data value went wrong.@Nullable DataValue get(String name)
name
- the variable name@NotNull String toXml()
GomEditorProvider getGomProvider()
List<String> getVariableNames()
DataValue get(int index) throws IndexOutOfBoundsException
index
- The index to look up.IndexOutOfBoundsException
- If the index is out of bounds.int indexOf(String name)
name
- the variable nameIterator<DataValue> iterator()
DataValue
's.
The returned iterator does not support Iterator.remove()
!int getSize()
boolean hasData()
DataValue
where DataValue.getEditor().isSet()
evaluates to
true
.true
, iff some value is set.boolean isRelease()
true
, if released.Reference[] getReferences()
boolean isMeta()
true
if the held data is meta data.boolean isDefault()
true
, iff the held data are default data.boolean isValid()
true
, if valid.@Nullable @Deprecated MultiPageParams getMultiPageParams(@NotNull Language language)
null
. The method and the inheritance of MultiPageParamsProvider
will be removed
in a future version.getMultiPageParams
in interface MultiPageParamsProvider
null
Copyright © 2014 e-Spirit AG. All Rights Reserved. Build 5.0_BETA.500