ChildTopicsModel (DMX 5.0-SNAPSHOT API)

All Superinterfaces:

Iterable<String>, JSONEnabled

All Known Subinterfaces:

FacetValueModel

All Known Implementing Classes:

ChildTopicsModelImpl, FacetValueModelImpl
```
public interface ChildTopicsModel
extends JSONEnabled, Iterable<String>
```
A recursive composite of key/value pairs. ### FIXDOC
Keys are strings, values are non-null atomic (string, int, long, double, boolean) or again a ChildTopicsModel. ### FIXDOC

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ChildTopicsModel`	`add(String assocDefUri, RelatedTopicModel value)` Adds a value to a multiple-valued child.
`ChildTopicsModel`	`add(String assocDefUri, TopicModel value)`
`ChildTopicsModel`	`addDeletionRef(String assocDefUri, long refTopicId)` Adds a by-ID topic deletion reference to a multiple-valued child.
`ChildTopicsModel`	`addDeletionRef(String assocDefUri, String refTopicUri)` Adds a by-URI topic deletion reference to a multiple-valued child.
`ChildTopicsModel`	`addRef(String assocDefUri, long refTopicId)` Adds a by-ID topic reference to a multiple-valued child.
`ChildTopicsModel`	`addRef(String assocDefUri, String refTopicUri)` Adds a by-URI topic reference to a multiple-valued child.
`ChildTopicsModel`	`clone()`
`Object`	`get(String assocDefUri)` Accesses a child generically, regardless of single-valued or multiple-valued.
`boolean`	`getBoolean(String assocDefUri)` Convenience accessor for the simple value of a single-valued child.
`boolean`	`getBoolean(String assocDefUri, boolean defaultValue)` Convenience accessor for the simple value of a single-valued child.
`ChildTopicsModel`	`getChildTopicsModel(String assocDefUri)` Convenience accessor for the composite value of a single-valued child.
`ChildTopicsModel`	`getChildTopicsModel(String assocDefUri, ChildTopicsModel defaultValue)` Convenience accessor for the composite value of a single-valued child.
`double`	`getDouble(String assocDefUri)` Convenience accessor for the simple value of a single-valued child.
`double`	`getDouble(String assocDefUri, double defaultValue)` Convenience accessor for the simple value of a single-valued child.
`int`	`getInt(String assocDefUri)` Convenience accessor for the simple value of a single-valued child.
`int`	`getInt(String assocDefUri, int defaultValue)` Convenience accessor for the simple value of a single-valued child.
`long`	`getLong(String assocDefUri)` Convenience accessor for the simple value of a single-valued child.
`long`	`getLong(String assocDefUri, long defaultValue)` Convenience accessor for the simple value of a single-valued child.
`Object`	`getObject(String assocDefUri)` Convenience accessor for the simple value of a single-valued child.
`Object`	`getObject(String assocDefUri, Object defaultValue)` Convenience accessor for the simple value of a single-valued child.
`String`	`getString(String assocDefUri)` Convenience accessor for the simple value of a single-valued child.
`String`	`getString(String assocDefUri, String defaultValue)` Convenience accessor for the simple value of a single-valued child.
`RelatedTopicModel`	`getTopic(String assocDefUri)` Accesses a single-valued child.
`RelatedTopicModel`	`getTopicOrNull(String assocDefUri)` Accesses a single-valued child.
`List<? extends RelatedTopicModel>`	`getTopics(String assocDefUri)` Accesses a multiple-valued child.
`List<? extends RelatedTopicModel>`	`getTopicsOrNull(String assocDefUri)` Accesses a multiple-valued child.
`ChildTopicsModel`	`put(String assocDefUri, ChildTopicsModel value)` Convenience method to put a composite value in a single-valued child.
`ChildTopicsModel`	`put(String assocDefUri, List<RelatedTopicModel> values)` Sets the values of a multiple-valued child.
`ChildTopicsModel`	`put(String assocDefUri, Object value)` Convenience method to put a simple value in a single-valued child.
`ChildTopicsModel`	`put(String assocDefUri, RelatedTopicModel value)` Puts a value in a single-valued child.
`ChildTopicsModel`	`put(String assocDefUri, TopicModel value)`
`ChildTopicsModel`	`putDeletionRef(String assocDefUri, long refTopicId)` Puts a by-ID topic deletion reference in a single-valued child.
`ChildTopicsModel`	`putDeletionRef(String assocDefUri, String refTopicUri)` Puts a by-URI topic deletion reference in a single-valued child.
`ChildTopicsModel`	`putRef(String assocDefUri, long refTopicId)` Puts a by-ID topic reference in a single-valued child.
`ChildTopicsModel`	`putRef(String assocDefUri, String refTopicUri)` Puts a by-URI topic reference in a single-valued child.
`ChildTopicsModel`	`remove(String assocDefUri)` Removes a single-valued child.
`ChildTopicsModel`	`remove(String assocDefUri, TopicModel value)` Removes a value from a multiple-valued child.

Methods inherited from interface systems.dmx.core.JSONEnabled
toJSON

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Method Detail
  - getTopic
```
RelatedTopicModel getTopic(String assocDefUri)
```
    Accesses a single-valued child. Throws if there is no such child.
  - getTopicOrNull
```
RelatedTopicModel getTopicOrNull(String assocDefUri)
```
    Accesses a single-valued child. Returns null if there is no such child.
  - getTopics
```
List<? extends RelatedTopicModel> getTopics(String assocDefUri)
```
    Accesses a multiple-valued child. Throws if there is no such child. ### TODO: return empty list instead
  - getTopicsOrNull
```
List<? extends RelatedTopicModel> getTopicsOrNull(String assocDefUri)
```
    Accesses a multiple-valued child. Returns null if there is no such child. ### TODO: drop this method
  - get
```
Object get(String assocDefUri)
```
    Accesses a child generically, regardless of single-valued or multiple-valued. Returns null if there is no such child.
    
    Returns:
    
    A RelatedTopicModel or List, or null if there is no such child.
  - getString
```
String getString(String assocDefUri)
```
    Convenience accessor for the *simple* value of a single-valued child. Throws if the child doesn't exist.
  - getString
```
String getString(String assocDefUri,
                 String defaultValue)
```
    Convenience accessor for the *simple* value of a single-valued child. Returns a default value if the child doesn't exist.
  - getInt
```
int getInt(String assocDefUri)
```
    Convenience accessor for the *simple* value of a single-valued child. Throws if the child doesn't exist.
  - getInt
```
int getInt(String assocDefUri,
           int defaultValue)
```
    Convenience accessor for the *simple* value of a single-valued child. Returns a default value if the child doesn't exist.
  - getLong
```
long getLong(String assocDefUri)
```
    Convenience accessor for the *simple* value of a single-valued child. Throws if the child doesn't exist.
  - getLong
```
long getLong(String assocDefUri,
             long defaultValue)
```
    Convenience accessor for the *simple* value of a single-valued child. Returns a default value if the child doesn't exist.
  - getDouble
```
double getDouble(String assocDefUri)
```
    Convenience accessor for the *simple* value of a single-valued child. Throws if the child doesn't exist.
  - getDouble
```
double getDouble(String assocDefUri,
                 double defaultValue)
```
    Convenience accessor for the *simple* value of a single-valued child. Returns a default value if the child doesn't exist.
  - getBoolean
```
boolean getBoolean(String assocDefUri)
```
    Convenience accessor for the *simple* value of a single-valued child. Throws if the child doesn't exist.
  - getBoolean
```
boolean getBoolean(String assocDefUri,
                   boolean defaultValue)
```
    Convenience accessor for the *simple* value of a single-valued child. Returns a default value if the child doesn't exist.
  - getObject
```
Object getObject(String assocDefUri)
```
    Convenience accessor for the *simple* value of a single-valued child. Throws if the child doesn't exist.
  - getObject
```
Object getObject(String assocDefUri,
                 Object defaultValue)
```
    Convenience accessor for the *simple* value of a single-valued child. Returns a default value if the child doesn't exist.
  - getChildTopicsModel
```
ChildTopicsModel getChildTopicsModel(String assocDefUri)
```
    Convenience accessor for the *composite* value of a single-valued child. Throws if the child doesn't exist.
  - getChildTopicsModel
```
ChildTopicsModel getChildTopicsModel(String assocDefUri,
                                     ChildTopicsModel defaultValue)
```
    Convenience accessor for the *composite* value of a single-valued child. Returns a default value if the child doesn't exist.
  - put
```
ChildTopicsModel put(String assocDefUri,
                     RelatedTopicModel value)
```
    Puts a value in a single-valued child. An existing value is overwritten.
  - put
```
ChildTopicsModel put(String assocDefUri,
                     TopicModel value)
```
  - put
```
ChildTopicsModel put(String assocDefUri,
                     Object value)
```
    Convenience method to put a *simple* value in a single-valued child. An existing value is overwritten.
    
    Parameters:
    
    value - a String, Integer, Long, Double, or a Boolean.
    
    Returns:
    
    this ChildTopicsModel.
  - put
```
ChildTopicsModel put(String assocDefUri,
                     ChildTopicsModel value)
```
    Convenience method to put a *composite* value in a single-valued child. An existing value is overwritten.
    
    Returns:
    
    this ChildTopicsModel.
  - putRef
```
ChildTopicsModel putRef(String assocDefUri,
                        long refTopicId)
```
    Puts a by-ID topic reference in a single-valued child. An existing reference is overwritten.
  - putRef
```
ChildTopicsModel putRef(String assocDefUri,
                        String refTopicUri)
```
    Puts a by-URI topic reference in a single-valued child. An existing reference is overwritten.
  - putDeletionRef
```
ChildTopicsModel putDeletionRef(String assocDefUri,
                                long refTopicId)
```
    Puts a by-ID topic deletion reference in a single-valued child. An existing value is overwritten.
  - putDeletionRef
```
ChildTopicsModel putDeletionRef(String assocDefUri,
                                String refTopicUri)
```
    Puts a by-URI topic deletion reference in a single-valued child. An existing value is overwritten.
  - remove
```
ChildTopicsModel remove(String assocDefUri)
```
    Removes a single-valued child.
  - add
```
ChildTopicsModel add(String assocDefUri,
                     RelatedTopicModel value)
```
    Adds a value to a multiple-valued child.
  - add
```
ChildTopicsModel add(String assocDefUri,
                     TopicModel value)
```
  - put
```
ChildTopicsModel put(String assocDefUri,
                     List<RelatedTopicModel> values)
```
    Sets the values of a multiple-valued child. Existing values are overwritten.
  - remove
```
ChildTopicsModel remove(String assocDefUri,
                        TopicModel value)
```
    Removes a value from a multiple-valued child.
  - addRef
```
ChildTopicsModel addRef(String assocDefUri,
                        long refTopicId)
```
    Adds a by-ID topic reference to a multiple-valued child.
  - addRef
```
ChildTopicsModel addRef(String assocDefUri,
                        String refTopicUri)
```
    Adds a by-URI topic reference to a multiple-valued child.
  - addDeletionRef
```
ChildTopicsModel addDeletionRef(String assocDefUri,
                                long refTopicId)
```
    Adds a by-ID topic deletion reference to a multiple-valued child.
  - addDeletionRef
```
ChildTopicsModel addDeletionRef(String assocDefUri,
                                String refTopicUri)
```
    Adds a by-URI topic deletion reference to a multiple-valued child.
  - clone
```
ChildTopicsModel clone()
```

Interface ChildTopicsModel

Method Summary

Methods inherited from interface systems.dmx.core.JSONEnabled

Methods inherited from interface java.lang.Iterable

Method Detail

getTopic

getTopicOrNull

getTopics

getTopicsOrNull

get

getString

getString

getInt

getInt

getLong

getLong

getDouble

getDouble

getBoolean

getBoolean

getObject

getObject

getChildTopicsModel

getChildTopicsModel

put

put

put

put

putRef

putRef

putDeletionRef

putDeletionRef

remove

add

add

put

remove

addRef

addRef

addDeletionRef

addDeletionRef

clone