Skip to main content

CkCompiledTypeDto

Namespace: Meshmakers.Octo.ConstructionKit.Contracts.DataTransferObjects

Compiled version of a CK type.

public class CkCompiledTypeDto : CkTypeDto

Inheritance Object → CkTypeWithAttributesDto → CkTypeDto → CkCompiledTypeDto

Properties​

IsCollectionRoot​

Gets or sets a value indicating whether this type is a collection root.

public bool IsCollectionRoot { get; set; }

Property Value​

Boolean

TypeId​

Gets or sets the construction kit id

public CkTypeId TypeId { get; set; }

Property Value​

CkTypeId

DerivedFromCkTypeId​

Defines the base type of this type. Only one type may not have a base type: System/Entity

public CkId<CkTypeId> DerivedFromCkTypeId { get; set; }

Property Value​

CkId<CkTypeId>

IsFinal​

If true, the type cannot be inherited again

public bool IsFinal { get; set; }

Property Value​

Boolean

IsAbstract​

If true, the type cannot be instantiated by a runtime entity

public bool IsAbstract { get; set; }

Property Value​

Boolean

Indexes​

Gets or sets a list of indexes

public List<CkTypeIndexDto> Indexes { get; set; }

Property Value​

List<CkTypeIndexDto>

Associations​

Get or sets a list of associations

public List<CkTypeAssociationDto> Associations { get; set; }

Property Value​

List<CkTypeAssociationDto>

EnableChangeStreamPreAndPostImages​

Gets or sets if the change stream should include pre and post images

public bool EnableChangeStreamPreAndPostImages { get; set; }

Property Value​

Boolean

Description​

An optional description of the type

public string Description { get; set; }

Property Value​

String

DisplayNameRule​

Optional rule defining how the display name (rtDisplayName) of a runtime entity is computed from its attribute values on save, e.g. "${roomNumber} - ${name ?? globalId}". Supports ${attributePath} interpolation (own attributes including record paths, no associations) and the ?? coalesce operator. Inherited along the derivedFromCkTypeId chain; a derived type may override it with its own rule (nearest non-empty rule wins).

public string DisplayNameRule { get; set; }

Property Value​

String

DisplayDescriptionRule​

Optional rule defining how the display description (rtDisplayDescription) of a runtime entity is computed from its attribute values on save. Same syntax and inheritance semantics as CkTypeDto.DisplayNameRule.

public string DisplayDescriptionRule { get; set; }

Property Value​

String

OwnerAttributePath​

Optional attribute path whose value identifies the owner (subject id) of a runtime entity for owned-only data permissions (AB#4978), e.g. "AssigneeId" or "Owner.UserId". When absent, ownership is the server-stamped rtCreatedBy. Inherited along the derivedFromCkTypeId chain; a derived type may override it (nearest declared path wins). Dot-separated segments traverse single-valued Record attributes (RecordArray segments are rejected — ownership would be multi-valued); the terminal segment must be of value type String. Associations are not traversable.

public string OwnerAttributePath { get; set; }

Property Value​

String

Attributes​

Gets or sets a list of attributes

public List<CkTypeAttributeDto> Attributes { get; set; }

Property Value​

List<CkTypeAttributeDto>

Constructors​

CkCompiledTypeDto()​

public CkCompiledTypeDto()