public interface FeatureModel
browse
and modify the feature content by adding
or removing
content objects ( IDProvider
or data records
. To persist modifications to this feature, call FeatureAgent.saveFeature(FeatureModel)
. Missing References:missing references
. These references are differentiated in essential references
andoptional references
. A feature is transportable
although it has missing essential references
but during installing thefeature transport file to a target project
the different types of missing references will be important.Missing essential references
which couldn't be mapped to existing elements intarget project will cause the feature to be not installable. In contrast missing optional references
which couldn't be mapped will causewarnings but the feature will stay installable.FeatureAgent
,
FeatureDescriptor
Modifier and Type | Interface and Description |
---|---|
static interface |
FeatureModel.FeatureDatasetReference
Definition of an feature reference referencing a dataset.
|
static interface |
FeatureModel.FeatureElementReference
Definition of an feature reference referencing a store node.
|
static interface |
FeatureModel.FeatureReference<T extends IDProvider>
Definition representing a feature reference.
|
static class |
FeatureModel.FeatureReferencesType
Type of
feature references . |
Modifier and Type | Method and Description |
---|---|
boolean |
add(Collection<IDProvider> elementsToAdd)
Adds the given elements collection to this feature model.
|
boolean |
add(IDProvider elementToAdd)
Adds the given element to this feature model.
|
PropertiesTransportOptions |
configurePropertiesTransport()
Request a options object to configure global properties transport.
|
Map<Schema,Map<EntityType,Collection<Dataset>>> |
getDataRecords()
Returns all
data records contained in this feature model as an unmodifiable map. |
Pair<Collection<FeatureModel.FeatureReference<?>>,Collection<FeatureModel.FeatureReference<?>>> |
getMissingReferences()
Returns all missing references of this feature model existing at time calling this method.
|
Map<Store.Type,Collection<IDProvider>> |
getStoreNodes()
Returns all store nodes contained in this feature model as an unmodifiable mapping from
store type to a collection of IdProvider. |
boolean |
remove(IDProvider toRemove)
Removes the given element from this feature model.
|
boolean add(IDProvider elementToAdd)
dataset
provided by Content2.getDataset(Entity)
to add a data record to this feature.elementToAdd
- the element which should be added to the feature modeltrue
if the model has been modified, i.e. when the element has been added. If the model alreadycontained the element, false
is returned.FeatureAgent.saveFeature(FeatureModel)
boolean add(Collection<IDProvider> elementsToAdd)
datasets
provided by Content2.getDataset(Entity)
to add data records to this feature.elementsToAdd
- the elements which should be added to the feature modeltrue
if the model has been modified, i.e. when at least one element has been added. If the modelalready contained all elements, false
is returned.FeatureAgent.saveFeature(FeatureModel)
boolean remove(IDProvider toRemove)
dataset
provided by Content2.getDataset(Entity)
to remove a data record from this feature.toRemove
- the element which should be removedtrue
if the model has been modified, i.e. when the element has been removed. If the model did notcontain the element, false
is returned.FeatureAgent.saveFeature(FeatureModel)
@NotNull Map<Store.Type,Collection<IDProvider>> getStoreNodes()
store type
to a collection of IdProvider. Returned map contains only start nodes, therefore all children of these nodes are part of the feature too.add(IDProvider)
or remove(IDProvider)
will not affect the returned map.getDataRecords()
@NotNull Map<Schema,Map<EntityType,Collection<Dataset>>> getDataRecords()
data records
contained in this feature model as an unmodifiable map.add(Dataset)
or remove(Dataset)
will not affect the returned map.getStoreNodes()
Pair<Collection<FeatureModel.FeatureReference<?>>,Collection<FeatureModel.FeatureReference<?>>> getMissingReferences()
key
and missing optional references asvalue
.PropertiesTransportOptions configurePropertiesTransport() throws SecurityException
project admins
. Will throw an security exception otherwise.SecurityException
- if current user is no project admin of the belonging projectCopyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210