Class RelationDefinition
A relation definitions.
Inherited Members
Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ModelsBase
Assembly: Stylelabs.M.Sdk.dll
Syntax
public class RelationDefinition : MemberDefinitionBase, IRelationDefinition, IMemberDefinitionProperties
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
public bool AllowNavigation { get; set; }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
public string AssociatedEntityDefinitionName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
AssociatedLabels
Gets collection of the culture specific member labels of the associated relation definition.
Declaration
public IDictionary<CultureInfo, string> AssociatedLabels { get; set; }Property Value
| Type | Description |
|---|---|
| IDictionary<, >CultureInfostring |
Cardinality
Gets or sets cardinality of the relation from the parents point of view.
Declaration
public RelationCardinality Cardinality { get; set; }Property Value
| Type | Description |
|---|---|
| RelationCardinality |
ChildIsMandatory
Gets or sets a value indicating whether relations of this definition must have at least one child.
Declaration
public bool ChildIsMandatory { get; set; }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
public bool CompletionIsCopied { get; set; }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
public bool ContentIsCopied { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
See Also
DefinitionType
Gets type of the member.
Declaration
public override MemberDefinitionType DefinitionType { get; }Property Value
| Type | Description |
|---|---|
| MemberDefinitionType |
Overrides
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
public bool InheritsSecurity { get; set; }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
public bool IsNested { get; set; }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
public bool IsPathHierarchyRelation { get; set; }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
public bool IsPathRelation { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
IsRenditionRelation
Gets or sets a value indicating whether this relation can be used to retrieve renditions.
Declaration
public bool IsRenditionRelation { get; set; }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
public bool IsTaxonomyHierarchyRelation { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
IsTaxonomyRelation
Gets or sets a value indicating whether the relation establishes a taxonomy.
Declaration
public bool IsTaxonomyRelation { get; set; }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
public bool NestedPermissions { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
NestedProperties
Gets collection of the property names of the associated entity to be used for nesting.
Declaration
public IList<string> NestedProperties { get; set; }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
public bool ParentIsMandatory { get; set; }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
public byte PathHierarchyScore { get; set; }Property Value
| Type | Description |
|---|---|
| byte |
Role
Gets or sets role of the relation on the IEntityDefinition. Parent and child entity definitions share the same conceptual relation definition.
Declaration
public RelationRole Role { get; set; }Property Value
| Type | Description |
|---|---|
| RelationRole |