Package ch.tocco.nice2.optional.qualification.api.util.entities

Interface Instance

All Known Implementing Classes:

AbstractInstance, Evaluation, Input

public interface Instance

Method Summary

Modifier and Type	Method	Description
com.google.common.collect.Multimap<String,Instance>	getChildrenMap()	Keys are the 'short' field (see getShort()) of an Instance, values are all child instances of this instance
@Nullable org.joda.time.LocalDate	getDate()
Optional<Object>	getRatingData(Entity user)
String	getShort()
String	getUniqueKey()	get a string that uniquely identifies this instance.

Method Details

getShort

String getShort()

Returns:

the 'short' field of the underlying entity. it should uniquely describe this instance^s node

getDate

@Nullable
@Nullable org.joda.time.LocalDate getDate()

getChildrenMap

com.google.common.collect.Multimap<String,Instance> getChildrenMap()

Keys are the 'short' field (see getShort()) of an Instance, values are all child instances of this instance

Returns:

a map of all children of this node, including thid node itself

getRatingData

Optional<Object> getRatingData(Entity user)

Parameters:

user - a User entity

Returns:

an optional rating object (type depending on the type of the underlying node)

getUniqueKey

String getUniqueKey()

get a string that uniquely identifies this instance. currently, format is Model-Key.

Returns:

the unique key