memoryx::EntityMemorySegmentInterface

Overview

[ "cpp:virtual" ] interface EntityMemorySegmentInterface

Derived Classes and Interfaces

PersistentEntitySegmentBase

WorkingMemoryEntitySegmentBase

Operation Index

getObjectTypeId

addEntity

addEntityList

updateEntity

upsertEntity

Updates or insert entity.

upsertEntityByName

upsertEntityList

removeEntity

removeAllEntities

setEntityAttribute

set attribute on entity with ID entityId

setEntityAttributes

set all attributes in attributeList on entity with ID entityId

hasEntityById

hasEntityByName

getEntityById

getJSONEntityById

getEntityRefById

getEntityByName

getEntityRefByName

getEntitiesByAttrValue

getEntitiesByAttrValueList

getEntityWithChildrenById

getEntityWithChildrenByName

getAllEntityIds

getAllEntities

getIdEntityMap

getSegmentName

lockSegment

keepLockAlive

unlockSegment

unlockSegmentWithToken

Operations

string getObjectTypeId()

string addEntity(EntityBase entity) throws InvalidEntityException

EntityIdList addEntityList(EntityBaseList entityList)

void updateEntity(string entityId, EntityBase update) throws InvalidEntityException, EntityNotFoundException

string upsertEntity(string entityId, EntityBase newEntity) throws InvalidEntityException

Updates or insert entity. If not found with given id, entity is inserted and id is returned.

string upsertEntityByName(string entityName, EntityBase newEntity) throws InvalidEntityException

EntityIdList upsertEntityList(EntityBaseList entityList)

void removeEntity(string entityId) throws EntityNotFoundException

void removeAllEntities()

void setEntityAttribute(string entityId, EntityAttributeBase attribute)

set attribute on entity with ID entityId

void setEntityAttributes(string entityId, EntityAttributeList attributeList)

set all attributes in attributeList on entity with ID entityId

bool hasEntityById(string entityId)

bool hasEntityByName(string entityName)

EntityBase getEntityById(string entityId)

string getJSONEntityById(string entityId)

EntityRefBase getEntityRefById(string entityId)

EntityBase getEntityByName(string entityName)

EntityRefBase getEntityRefByName(string entityName)

EntityBaseList getEntitiesByAttrValue(string attrName, string attrValue)

EntityBaseList getEntitiesByAttrValueList(string attrName, NameList attrValueList)

EntityBaseList getEntityWithChildrenById(string entityId, bool includeMetaEntities)

EntityBaseList getEntityWithChildrenByName(string entityName, bool includeMetaEntities)

EntityIdList getAllEntityIds()

EntityBaseList getAllEntities()

IdEntityMap getIdEntityMap()

string getSegmentName()

SegmentLockBase lockSegment()

bool keepLockAlive(string token) throws InvalidLockTokenException

bool unlockSegment(SegmentLockBase lock) throws InvalidLockTokenException

bool unlockSegmentWithToken(string token) throws InvalidLockTokenException