Skip to main content

AssociationUpdateInfo

Namespace: Meshmakers.Octo.Runtime.Contracts

Data transfer object for association update.

public record AssociationUpdateInfo : IEquatable<AssociationUpdateInfo>

Inheritance ObjectAssociationUpdateInfo
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 CkId<CkAssociationRoleId> RoleId { get; }

Property Value

CkId<CkAssociationRoleId>

ModOption

Mod option.

public AssociationModOptionsDto ModOption { get; }

Property Value

AssociationModOptionsDto

Constructors

AssociationUpdateInfo(RtEntityId, RtEntityId, CkId<CkAssociationRoleId>, AssociationModOptionsDto)

Creates a new instance of AssociationUpdateInfo.

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

Parameters

origin RtEntityId

target RtEntityId

roleId CkId<CkAssociationRoleId>

modOption AssociationModOptionsDto

Methods

CreateCreate(RtEntityId, RtEntityId, CkId<CkAssociationRoleId>)

Creates an association update info for creating an association.

public static AssociationUpdateInfo CreateCreate(RtEntityId origin, RtEntityId target, CkId<CkAssociationRoleId> roleId)

Parameters

origin RtEntityId
Runtime entity identifier of the origin entity.

target RtEntityId
Runtime entity identifier of the target entity.

roleId CkId<CkAssociationRoleId>
Role identifier of the association.

Returns

AssociationUpdateInfo
Create association update info.

CreateDelete(RtEntityId, RtEntityId, CkId<CkAssociationRoleId>)

Creates an association update info for deleting an association.

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

Parameters

origin RtEntityId
Runtime entity identifier of the origin entity.

target RtEntityId
Runtime entity identifier of the target entity.

roleId CkId<CkAssociationRoleId>
Role identifier of the association.

Returns

AssociationUpdateInfo
Create association update info.