[DataContract]
[MultipleUnique(new string[] { "Name", "EntityID" })]
public class AllocationRule : BaseEntityWithPermissions, IAllocationRule, IBaseEntityWithPermissions, ISetCopier, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<IAllocationRule>, ISetCopierCloneAlterer

Constructors

AllocationRule()

Declaration

public AllocationRule()

Properties

AllocationMethodID

Links to IAllocationMethod. For allocation method

Declaration

public Guid? AllocationMethodID { get; set; }

Property Value

Type	Description
Guid?

AllocationMethodID_Label

Declaration

public string AllocationMethodID_Label { get; set; }

Property Value

Type	Description
string

AllocationMethodID_Label_Silent

Declaration

[NotMapped]
public string AllocationMethodID_Label_Silent { get; set; }

Property Value

Type	Description
string

AllocationPathSplitType

Specifies how the allocation rule should handle PathSplit from AllocationPath. Default is SpecifiedSplit - use PathSplit when generating allocations. AlwaysIgnore option ignores Path Split and always produces the same results

Declaration

[EnumDataType(typeof(AllocationPathSplitType))]
public AllocationPathSplitType AllocationPathSplitType { get; set; }

Property Value

Type	Description
AllocationPathSplitType

Declaration

[NotMapped]
public string AllocationPathSplitType_Tooltip { get; set; }

Property Value

Type	Description
string

AllocationPathType

The way in which allocations are calculated along a path. Default is that each vehicle in the path has its amount calculated from the total amount for entities it allocates to (TotalAmount)

Declaration

[EnumDataType(typeof(AllocationPathType))]
public AllocationPathType AllocationPathType { get; set; }

Property Value

Type	Description
AllocationPathType

Declaration

[NotMapped]
public string AllocationPathType_Tooltip { get; set; }

Property Value

Type	Description
string

CopierCloneType

Declaration

public SetCopierCloneType CopierCloneType { get; set; }

Property Value

Type	Description
SetCopierCloneType

Description

A user friendly description of this allocation rule.

Declaration

[StringLength(2000)]
public string Description { get; set; }

Property Value

Type	Description
string

EntityID

[Key] Links to IObjectEntity. The entity within the entity set that this rule is for, and is allocating from

Declaration

public Guid? EntityID { get; set; }

Property Value

Type	Description
Guid?

EntityID_Label

Declaration

public string EntityID_Label { get; set; }

Property Value

Type	Description
string

EntityID_Label_Silent

Declaration

[NotMapped]
public string EntityID_Label_Silent { get; set; }

Property Value

Type	Description
string

EntitySetID

Links to IEntitySet. The entity set this rule is contained within

Declaration

public Guid? EntitySetID { get; set; }

Property Value

Type	Description
Guid?

EntitySetID_Label

Declaration

public string EntitySetID_Label { get; set; }

Property Value

Type	Description
string

EntitySetID_Label_Silent

Declaration

[NotMapped]
public string EntitySetID_Label_Silent { get; set; }

Property Value

Type	Description
string

FolderID

The link to the folder this item is contained in

Declaration

public Guid? FolderID { get; set; }

Property Value

Type	Description
Guid?

FolderID_Label

Declaration

public string FolderID_Label { get; set; }

Property Value

Type	Description
string

FolderID_Label_Silent

Declaration

[NotMapped]
public string FolderID_Label_Silent { get; set; }

Property Value

Type	Description
string

Name

[Key] The unique user friendly name of this rule

Declaration

[Required]
[StringLength(500)]
public string Name { get; set; }

Property Value

Type	Description
string

Methods

AlterCopiedItem(IEntityUpdater, UserInfo, IReadOnlyCache, IBaseEntity)

A custom ability to alter this item when it is was copied by the user in the UI, not when it is being imported

Declaration

public Task AlterCopiedItem(IEntityUpdater host, UserInfo user, IReadOnlyCache cache, IBaseEntity sourceItem)

Parameters

Type	Name	Description
IEntityUpdater	host	The context this item was copied into
UserInfo	user	The current user
IReadOnlyCache	cache	The current local cache
IBaseEntity	sourceItem	The original source item this item was copied from

Returns

Type	Description
Task	A task inidicating the finishing of this method

CopyFromEntity(IBaseEntity)

Declaration

protected override void CopyFromEntity(IBaseEntity src)

Parameters

Type	Name	Description
IBaseEntity	src

Overrides

BaseEntity.CopyFromEntity(IBaseEntity)

CopyFromSource(IAllocationRule)

Updates all properties in this item to have the same properties as the source object.

Declaration

public void CopyFromSource(IAllocationRule source)

Parameters

Type	Name	Description
IAllocationRule	source	The source object to copy all values from.

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string