Class PropRelationshipAttribute
The base attribute used for marking that a given property holds a relationship to another entity in the system
Includes attributes about the relationship such as cascade delete options and others
Inheritance
Inherited Members
Namespace: LemonEdge.API.Attributes
Assembly: LemonEdge.API.dll
Syntax
public abstract class PropRelationshipAttribute : AttributeConstructors
PropRelationshipAttribute()
Declaration
protected PropRelationshipAttribute()Properties
DeleteWithRelationship
Indicates when the parent entity is deleted all child entities through this relationship should be deleted too
Declaration
public bool DeleteWithRelationship { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
InheritPermissions
Indicates the permissions for this entity are inherited from the target entity of this relationship.
Typically this means this entity itself does not need to inherit from IBaseEntityWithPermissions and instead can just inherit from IBaseEntity
Declaration
public bool InheritPermissions { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
IsTypeExtender
Indicates this relationship points to the ID column of the target type, and "extends" the properties of that type. In other words from a UI perspective this object can be displayed against an instance of the target type
Declaration
public bool IsTypeExtender { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
JoinType
Holds the type of join this relationship holds. Either a zero to one, or one, relationship indicating if the relationship can be null or not.
Declaration
public SingleJoinType JoinType { get; set; }Property Value
| Type | Description |
|---|---|
| SingleJoinType |
LinkToItemInSet
Indicates this points to an item that we should include when exporting/copying this item itself PartOfParentSet = true on a userrole.userid relationship, would indicate we always export the role links when exporting a user LinkToItemInSet = false on userrole.roleid relationship, would indicate we don't want to traverse this export any further when exporting a user. we only want to export the user and role links, not traverse further and export the roles it links to as well.
Declaration
public bool LinkToItemInSet { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
PartOfParentSet
Indicates this item is a part of the set in the parent item When copying/exporting, they are done as a set.
Declaration
public bool PartOfParentSet { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
PreventAutoConstraint
Indicates the system should not create constraints for this relationship on the tables for this source entity
Declaration
public bool PreventAutoConstraint { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
SourceLabel
The label to use when referring to this relationship from the source entity
Declaration
public string SourceLabel { get; set; }Property Value
| Type | Description |
|---|---|
| string |
TargetColumn
Holds the name of the target property on the target entity to use when joining using this relationship
Declaration
public string TargetColumn { get; set; }Property Value
| Type | Description |
|---|---|
| string |
TargetLabel
The label to use when referring to this relationship from the target entity
Declaration
public string TargetLabel { get; set; }Property Value
| Type | Description |
|---|---|
| string |