Interface Instance
- All Known Implementing Classes:
AbstractInstance
,Evaluation
,Input
public interface Instance
-
Method Summary
Modifier and TypeMethodDescriptionKeys are the 'short' field (seegetShort()
) of an Instance, values are all child instances of this instance@Nullable org.joda.time.LocalDate
getDate()
getRatingData
(Entity user) getShort()
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
Keys are the 'short' field (seegetShort()
) 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
- 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
-