Interface IRelationDefinition
Represents a data schema / domain model for relations on an IEntityDefinition.
Inherited Members
IMemberDefinition.AllowUpdates
IMemberDefinition.DefinitionType
IMemberDefinition.IsConditional
Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ContractsBase
Assembly: Stylelabs.M.Sdk.dll
Syntax
Properties
AllowNavigation
Gets or sets a value indicating whether this relation can be used for navigation to parents or children in the external services (e.g. REST API). This can prevent potentially serious memory intensive operations.
Declaration
Property Value
| Type | Description |
|---|---|
| bool |
AssociatedEntityDefinitionName
Gets or sets name of the IEntityDefinition that is linked to the other end (see Role) of this IRelationDefinition.
Declaration
Property Value
| Type | Description |
|---|---|
| string |
AssociatedLabels
Gets collection of the culture specific member labels of the associated relation definition.
Declaration
Property Value
| Type | Description |
|---|---|
| IDictionary<, >CultureInfostring |
Cardinality
Gets or sets cardinality of the relation from the parents point of view.
Declaration
Property Value
| Type | Description |
|---|---|
| RelationCardinality |
ChildIsMandatory
Gets or sets a value indicating whether relations of this definition must have at least one child.
Declaration
Property Value
| Type | Description |
|---|---|
| bool |
CompletionIsCopied
Gets or sets a value indicating whether the child of the relation copies words collection, used for the auto–complete, of the ancestors connected via such marked relations into its collection of words used for the auto-complete functionality in Sitecore Content Hub web portal.
Declaration
Property Value
| Type | Description |
|---|---|
| bool |
See Also
ContentIsCopied
Gets or sets a value indicating whether if the child of the relation copies full text search content of the ancestors connected via such marked relations into its full text search content.
Declaration
Property Value
| Type | Description |
|---|---|
| bool |
See Also
InheritsSecurity
Gets or sets a value indicating whether if this relation is used to inherit any security related meta data (from the parents towards the children).
Declaration
Property Value
| Type | Description |
|---|---|
| bool |
IsNested
Gets or sets a value indicating whether the relation allows nesting of properties on the associated entity when accessed via the external services (e.g. REST API).
Declaration
Property Value
| Type | Description |
|---|---|
| bool |
IsPathHierarchyRelation
Gets or sets a value indicating whether this relation provides a link between IsPathEnabledDefinition, thus creating a path hierarchy.
Declaration
Property Value
| Type | Description |
|---|---|
| bool |
IsPathRelation
Gets or sets a value indicating whether this relation provides a link between a parent entity with IsPathEnabledDefinition or an entity with such an ancestor.
Declaration
Property Value
| Type | Description |
|---|---|
| bool |
IsRenditionRelation
Gets or sets a value indicating whether this relation can be used to retrieve renditions.
Declaration
Property Value
| Type | Description |
|---|---|
| bool |
IsTaxonomyHierarchyRelation
Gets or sets a value indicating whether if the relation provides a link between parent and child taxonomy entities of the same entity definition, thus creating a taxonomy hierarchy.
Declaration
Property Value
| Type | Description |
|---|---|
| bool |
IsTaxonomyRelation
Gets or sets a value indicating whether the relation establishes a taxonomy.
Declaration
Property Value
| Type | Description |
|---|---|
| bool |
NestedPermissions
Gets or sets a value indicating whether permissions are included when nesting this relation in an external service, in similar fashion as with property nesting.
Declaration
Property Value
| Type | Description |
|---|---|
| bool |
NestedProperties
Gets collection of the property names of the associated entity to be used for nesting.
Declaration
Property Value
| Type | Description |
|---|---|
| IList<>string |
ParentIsMandatory
Gets or sets a value indicating whether relations of this definition must have at least one parent.
Declaration
Property Value
| Type | Description |
|---|---|
| bool |
PathHierarchyScore
Gets or sets score given to the relation which is marked as IsPathHierarchyRelation. If entity has multiple parent hierarchy relations, the paths of entity will be sorted according to this score in ascending way. The first path, if not marked otherwise, will be used as a sole entity path when only one path is required.
Declaration
Property Value
| Type | Description |
|---|---|
| byte |
Gets or sets role of the relation on the IEntityDefinition. Parent and child entity definitions share the same conceptual relation definition.
Declaration
Property Value
| Type | Description |
|---|---|
| RelationRole |