systems.dmx.core.model.facets

Interface FacetValueModel

Show UML class diagram

All Superinterfaces:

ChildTopicsModel, Iterable<String>, JSONEnabled

All Known Implementing Classes:

FacetValueModelImpl

public interface FacetValueModel
extends ChildTopicsModel

A facet value as used in update facet calls. Used for both, single-valued facets and multiple-valued facets.

Method Summary

Modifier and Type	Method and Description
FacetValueModel	addDeletionRef(long refTopicId) Adds a by-ID topic deletion reference to a multiple-valued facet.
FacetValueModel	addDeletionRef(String refTopicUri) Adds a by-URI topic deletion reference to a multiple-valued facet.
FacetValueModel	addRef(long refTopicId) Adds a by-ID topic reference to a multiple-valued facet.
FacetValueModel	addRef(String refTopicUri) Adds a by-URI topic reference to a multiple-valued facet.
RelatedTopicModel	getTopic() Accesses a single-valued facet.
List<? extends RelatedTopicModel>	getTopics() Accesses a multiple-valued facet.
FacetValueModel	put(ChildTopicsModel value) Convenience method to put a *composite* value in a single-valued facet.
FacetValueModel	put(List<RelatedTopicModel> values) Sets the values of a multiple-valued facet.
FacetValueModel	put(Object value) Convenience method to put a *simple* value in a single-valued facet.
FacetValueModel	put(RelatedTopicModel value) Puts a value in a single-valued facet.
FacetValueModel	put(TopicModel value)
FacetValueModel	putDeletionRef(long refTopicId) Puts a by-ID topic deletion reference in a single-valued facet.
FacetValueModel	putDeletionRef(String refTopicUri) Puts a by-URI topic deletion reference in a single-valued facet.
FacetValueModel	putRef(long refTopicId) Puts a by-ID topic reference in a single-valued facet.
FacetValueModel	putRef(String refTopicUri) Puts a by-URI topic reference in a single-valued facet.

Methods inherited from interface systems.dmx.core.model.ChildTopicsModel

add, add, addDeletionRef, addDeletionRef, addRef, addRef, clone, get, getBoolean, getBoolean, getChildTopicsModel, getChildTopicsModel, getDouble, getDouble, getInt, getInt, getLong, getLong, getObject, getObject, getString, getString, getTopic, getTopicOrNull, getTopics, getTopicsOrNull, put, put, put, put, put, putDeletionRef, putDeletionRef, putRef, putRef, remove, remove

Methods inherited from interface systems.dmx.core.JSONEnabled

toJSON

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getTopic

RelatedTopicModel getTopic()

Accesses a single-valued facet.

getTopics

List<? extends RelatedTopicModel> getTopics()

Accesses a multiple-valued facet.

put

FacetValueModel put(RelatedTopicModel value)

Puts a value in a single-valued facet.

put

FacetValueModel put(TopicModel value)

put

FacetValueModel put(Object value)

Convenience method to put a *simple* value in a single-valued facet.

put

FacetValueModel put(ChildTopicsModel value)

Convenience method to put a *composite* value in a single-valued facet.

putRef

FacetValueModel putRef(long refTopicId)

Puts a by-ID topic reference in a single-valued facet. An existing reference is overwritten.

putRef

FacetValueModel putRef(String refTopicUri)

Puts a by-URI topic reference in a single-valued facet. An existing reference is overwritten.

putDeletionRef

FacetValueModel putDeletionRef(long refTopicId)

Puts a by-ID topic deletion reference in a single-valued facet. An existing value is overwritten.

putDeletionRef

FacetValueModel putDeletionRef(String refTopicUri)

Puts a by-URI topic deletion reference in a single-valued facet. An existing value is overwritten.

put

FacetValueModel put(List<RelatedTopicModel> values)

Sets the values of a multiple-valued facet.

addRef

FacetValueModel addRef(long refTopicId)

Adds a by-ID topic reference to a multiple-valued facet.

addRef

FacetValueModel addRef(String refTopicUri)

Adds a by-URI topic reference to a multiple-valued facet.

addDeletionRef

FacetValueModel addDeletionRef(long refTopicId)

Adds a by-ID topic deletion reference to a multiple-valued facet.

addDeletionRef

FacetValueModel addDeletionRef(String refTopicUri)

Adds a by-URI topic deletion reference to a multiple-valued facet.