Skip to main content

AssociationUpdateInfo

Namespace: Meshmakers.Octo.Runtime.Contracts

Data transfer object for association update.

public record AssociationUpdateInfo : IEquatable<AssociationUpdateInfo>

Inheritance Object → AssociationUpdateInfo
Implements IEquatable<AssociationUpdateInfo>

Properties​

Origin​

Origin entity id.

public RtEntityId Origin { get; }

Property Value​

RtEntityId

Target​

Target entity id.

public RtEntityId Target { get; }

Property Value​

RtEntityId

RoleId​

Role of the association.

public RtCkId<CkAssociationRoleId> RoleId { get; }

Property Value​

RtCkId<CkAssociationRoleId>

ModOption​

Mod option.

public AssociationModOptionsDto ModOption { get; }

Property Value​

AssociationModOptionsDto

Constructors​

AssociationUpdateInfo(RtEntityId, RtEntityId, RtCkId<CkAssociationRoleId>, AssociationModOptionsDto)​

Creates a new instance of AssociationUpdateInfo.

public AssociationUpdateInfo(RtEntityId origin, RtEntityId target, RtCkId<CkAssociationRoleId> roleId, AssociationModOptionsDto modOption)

Parameters​

origin RtEntityId

target RtEntityId

roleId RtCkId<CkAssociationRoleId>

modOption AssociationModOptionsDto

Methods​

CreateInsert(RtEntityId, RtEntityId, RtCkId<CkAssociationRoleId>)​

Creates an association update info for inserting an association.

public static AssociationUpdateInfo CreateInsert(RtEntityId origin, RtEntityId target, RtCkId<CkAssociationRoleId> roleId)

Parameters​

origin RtEntityId
Runtime entity identifier of the origin entity.

target RtEntityId
Runtime entity identifier of the target entity.

roleId RtCkId<CkAssociationRoleId>
Role identifier of the association.

Returns​

AssociationUpdateInfo
Create association update info.

CreateDelete(RtEntityId, RtEntityId, RtCkId<CkAssociationRoleId>)​

Creates an association update info for deleting an association.

public static AssociationUpdateInfo CreateDelete(RtEntityId origin, RtEntityId target, RtCkId<CkAssociationRoleId> roleId)

Parameters​

origin RtEntityId
Runtime entity identifier of the origin entity.

target RtEntityId
Runtime entity identifier of the target entity.

roleId RtCkId<CkAssociationRoleId>
Role identifier of the association.

Returns​

AssociationUpdateInfo
Create association update info.