logo
logo
  • Interface IRelationDefinition

    Represents a data schema / domain model for relations on an IEntityDefinition.

    Namespace: Stylelabs.M.Sdk.Contracts.Base
    Assembly: Stylelabs.M.Sdk.dll
    Syntax
    public interface IRelationDefinition : IMemberDefinition

    Properties

    AllowNavigation

    Indicates 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
    bool AllowNavigation { get; set; }
    Property Value
    Type Description
    System.Boolean

    AssociatedEntityDefinitionName

    Name of the IEntityDefinition that is linked to the other end (see Role) of this IRelationDefinition.

    Declaration
    string AssociatedEntityDefinitionName { get; set; }
    Property Value
    Type Description
    System.String

    AssociatedLabels

    Collection of the culture specific member labels of the associated relation definition.

    Declaration
    IDictionary<CultureInfo, string> AssociatedLabels { get; }
    Property Value
    Type Description
    IDictionary<CultureInfo, System.String>

    Cardinality

    Cardinality of the relation from the parents point of view.

    Declaration
    RelationCardinality Cardinality { get; set; }
    Property Value
    Type Description
    RelationCardinality

    ChildIsMandatory

    Indicates whether relations of this definition must have at least one child.

    Declaration
    bool ChildIsMandatory { get; set; }
    Property Value
    Type Description
    System.Boolean

    CompletionIsCopied

    Indicates 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
    bool CompletionIsCopied { get; set; }
    Property Value
    Type Description
    System.Boolean
    See Also

    ContentIsCopied

    Indicates 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
    bool ContentIsCopied { get; set; }
    Property Value
    Type Description
    System.Boolean
    See Also

    InheritsSecurity

    Indicates if this relation is used to inherit any security related meta data (from the parents towards the children).

    Declaration
    bool InheritsSecurity { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsNested

    Indicates whether the relation allows nesting of properties on the associated entity when accessed via the external services (e.g. REST API).

    Declaration
    bool IsNested { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsPathHierarchyRelation

    Indicates whether this relation provides a link between IsPathEnabledDefinition, thus creating a path hierarchy.

    Declaration
    bool IsPathHierarchyRelation { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsPathRelation

    Indicates whether this relation provides a link between a parent entity with IsPathEnabledDefinition or an entity with such an ancestor.

    Declaration
    bool IsPathRelation { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsRenditionRelation

    Indicates whether this relation can be used to retrieve renditions.

    Declaration
    bool IsRenditionRelation { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsTaxonomyHierarchyRelation

    Indicates if the relation provides a link between parent and child taxonomy entities of the same entity definition, thus creating a taxonomy hierarchy.

    Declaration
    bool IsTaxonomyHierarchyRelation { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsTaxonomyRelation

    Indicates whether the relation establishes a taxonomy.

    Declaration
    bool IsTaxonomyRelation { get; set; }
    Property Value
    Type Description
    System.Boolean

    NestedPermissions

    Indicates whether permissions are included when nesting this relation in an external service, in similar fashion as with property nesting.

    Declaration
    bool NestedPermissions { get; set; }
    Property Value
    Type Description
    System.Boolean

    NestedProperties

    Collection of the property names of the associated entity to be used for nesting.

    Declaration
    IList<string> NestedProperties { get; }
    Property Value
    Type Description
    IList<System.String>

    ParentIsMandatory

    Indicates whether relations of this definition must have at least one parent.

    Declaration
    bool ParentIsMandatory { get; set; }
    Property Value
    Type Description
    System.Boolean

    PathHierarchyScore

    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
    byte PathHierarchyScore { get; set; }
    Property Value
    Type Description
    System.Byte

    Role

    Role of the relation on the IEntityDefinition. Parent and child entity definitions share the same conceptual relation definition.

    Declaration
    RelationRole Role { get; set; }
    Property Value
    Type Description
    RelationRole

    Can we improve this article ? Provide feedback