org.symphonyoss.s2.canon.runtime

Interface IEntity

All Superinterfaces:

IBaseEntity, org.symphonyoss.s2.common.dom.json.IJsonDomNodeProvider

All Known Subinterfaces:

IEntityBuilder

All Known Implementing Classes:

Entity, EntityBuilder

public interface IEntity
extends IBaseEntity

Interface representing a generated object type from a Canon model.

Author:

Bruce Skingle

Method Summary

Modifier and Type	Method and Description
Integer	getCanonMajorVersion()
Integer	getCanonMinorVersion()
String	getCanonType() Return the type identifier (_type JSON attribute) for this entity.
com.google.common.collect.ImmutableSet<String>	getCanonUnknownKeys() The set of keys present in the JSON from which this object was deserialized which are not defined by the schema.
org.symphonyoss.s2.common.dom.json.ImmutableJsonObject	getJsonObject() Return the JSON object from which this entity was created.

Methods inherited from interface org.symphonyoss.s2.canon.runtime.IBaseEntity

getJsonDomNode, serialize

Method Detail

getJsonObject

@Nonnull
org.symphonyoss.s2.common.dom.json.ImmutableJsonObject getJsonObject()

Return the JSON object from which this entity was created.

Returns:

the JSON object from which this entity was created.

getCanonType

@Nonnull
String getCanonType()

Return the type identifier (_type JSON attribute) for this entity.

Returns:

The type identifier for this object.

getCanonMajorVersion

@Nullable
Integer getCanonMajorVersion()

Returns:

The major part of the canon schema version defining this object.

getCanonMinorVersion

@Nullable
Integer getCanonMinorVersion()

Returns:

The minor part of the canon schema version defining this object.

getCanonUnknownKeys

com.google.common.collect.ImmutableSet<String> getCanonUnknownKeys()

The set of keys present in the JSON from which this object was deserialized which are not defined by the schema. In the case where an object extends some other object the super-class unknown keys will include all keys defined by the current class.

Returns:

The set of unknown keys in the JSON from which this object was deserialized;