ICommissionDocumentLineEntity Interface

CommissionDocumentLineEntity. Represents a sale document line not saved in database but used in commission calculations.

(Ligne de commission (Document))

Namespace: EBP.Api.Interfaces.Invoicing.Module.Entities.Colleague
Assembly: EBP.Api.XXX.Interfaces (in EBP.Api.XXX.Interfaces.dll) Version: 1.0.3.0

Syntax

Copy

[GuidAttribute("C7DB4B55-976E-4371-BF2B-39E34E1FDEEC")]
public interface ICommissionDocumentLineEntity : ICommissionLineEntity, 
	IEntity, IApiEntity, IDisposable, IEquatable<IProxy>

<GuidAttribute("C7DB4B55-976E-4371-BF2B-39E34E1FDEEC")>
Public Interface ICommissionDocumentLineEntity
	Inherits ICommissionLineEntity, IEntity, IApiEntity, IDisposable, 
	IEquatable(Of IProxy)

The ICommissionDocumentLineEntity type exposes the following members.

Properties

	Name	Description
	BlockGrossInterest	Gets or sets the BlockGrossInterest (Inherited from ICommissionLineEntity.)
	BlockGrossInterestMember	Gets the BlockGrossInterest (Inherited from ICommissionLineEntity.)
	BlockInterest	Gets or sets BlockInterest (Inherited from ICommissionLineEntity.)
	BlockInterestMember	Gets BlockInterest (Inherited from ICommissionLineEntity.)
	BlockQuantity	Quantity used to calculate commission (in block mode) (Inherited from ICommissionLineEntity.)
	BlockQuantityMember	Quantity used to calculate commission (in block mode) (Inherited from ICommissionLineEntity.)
	BlockTurnover	Gets or sets Block Turnover (Inherited from ICommissionLineEntity.)
	BlockTurnoverMember	Gets Block Turnover (Inherited from ICommissionLineEntity.)
	CreatedDate	Gets the Created Date (Inherited from IEntity.)
	CreatedUser	Gets the Created User (Inherited from IEntity.)
	DocumentId	Gets or sets DocumentId
	DocumentIdMember	Gets DocumentId
	DocumentLineId	Gets or sets DocumentLineId
	DocumentLineIdMember	Gets DocumentLineId
	DocumentNumber	Gets or sets DocumentId
	DocumentNumberMember	Gets DocumentId
	DocumentType	Gets or sets DocumentType List of authorized values in SaleDocumentSubTypes
	DocumentTypeMember	Gets DocumentType List of authorized values in SaleDocumentSubTypes
	EntityCaption	Gets the caption of the current entity, using the content (Inherited from IEntity.)
	EntityLabel	Gets the entity Label (Inherited from IEntity.)
	Errors	Gets the collection of errors (Inherited from IEntity.)
	GrossInterest	Gets or sets Global GrossInterest (Inherited from ICommissionLineEntity.)
	GrossInterestMember	Gets Global GrossInterest (Inherited from ICommissionLineEntity.)
	Interest	Gets or sets Global Interest (Inherited from ICommissionLineEntity.)
	InterestAmount	Gets or sets InterestAmount per item
	InterestAmountMember	Gets InterestAmount per item
	InterestMember	Gets Global Interest (Inherited from ICommissionLineEntity.)
	IsDeleted	Gets if the mode matches a deleted mode (Inherited from IEntity.)
	IsEmptyLine	Indicates if the entity is an empty line of an entity collection (created in auto following the entityCollection options) (Inherited from IEntity.)
	ItemCaption	Gets or sets ItemCaption
	ItemCaptionFromItem	Gets or sets the caption from item
	ItemCaptionFromItemMember	Gets the caption from item
	ItemCaptionMember	Gets ItemCaption
	ItemId	Gets or sets ItemId
	ItemIdMember	Gets ItemId
	Members	List of the members. It allows to acces to members with the name (Inherited from IEntity.)
	Mode	Gets the entity mode (Inherited from IEntity.)
	ModifiedDate	Gets the Modified Date (Inherited from IEntity.)
	ModifiedUser	Gets the Modified User (Inherited from IEntity.)
	OwnerEntity	Gets the main entity that own all this items/collection (Inherited from IEntity.)
	Parent	Gets the parent entity collection, that own this item (Inherited from IEntity.)
	ProratisedAmount	Gets or sets ProratisedAmount (used when parent line is a commitment line)
	ProratisedAmountMember	Gets ProratisedAmount (used when parent line is a commitment line)
	Quantity	Gets or sets Quantity (Inherited from ICommissionLineEntity.)
	QuantityMember	Gets Quantity (Inherited from ICommissionLineEntity.)
	ReadOnly	Gets/Sets if the entity is in read only mode, to preserve from data changing (Inherited from IEntity.)
	Silent	Get/Sets if the entity is in silent mode (Inherited from IEntity.)
	States	Gets the entity states (Inherited from IEntity.)
	ThirdId	Gets or sets ThirdId
	ThirdIdMember	Gets ThirdId
	ThirdName	Gets or sets ThirdName
	ThirdNameMember	Gets ThirdName
	Turnover	Gets or sets Turnover (Inherited from ICommissionLineEntity.)
	TurnoverMember	Gets Turnover (Inherited from ICommissionLineEntity.)

Top

Methods

	Name	Description
	Append	Method for add a new entity to the media. Update the entity to its default value. (Inherited from IEntity.)
	Cancel	Cancel the edit mode without saving, and reload the entity (Inherited from IEntity.)
	CancelEdit	Cancel the edit mode without saving, without reload the entity (Inherited from IEntity.)
	CheckData	Check the data of the entity (Inherited from IEntity.)
	Clear	Clear the entity content and reinitialize it to the default value (Inherited from IEntity.)
	Clone	Clone an entity (Inherited from IEntity.)
	CopyTo(IEntity)	Copy the entity content to another entity (Inherited from IEntity.)
	CopyTo(IEntity, Boolean)	Copy the entity content to another entity (Inherited from IEntity.)
	Delete	Method for delete a existing entity from the media (Inherited from IEntity.)
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
	Edit	Method to pass in edit mode a existing entity in the media (for exemple, add a lock for database) (Inherited from IEntity.)
	GetExtension	Gets the extension. (Inherited from IApiEntity.)
	Load	Method for loading the entity (Inherited from IEntity.)
	Save	Method for saving the entity to the media (Inherited from IEntity.)
	SetComplexMemberReadOnly	Set the read only property to a member (Inherited from IEntity.)
	ShowMessage	Method to display a message. The message is displayed if the UI has connected to the ShowMessage event (Inherited from IApiEntity.)

Top

Events

	Name	Description
	ModeChanged	Event raised on mode changed (Inherited from IEntity.)

Top

Remarks

The ICommissionDocumentLineEntity type can be instantiated with EBP.Api.Utils<TExtension>.GetInterface<T>

Copy

ICommissionDocumentLineEntity instance = Utils<ExtensionType>.GetInterface<ICommissionDocumentLineEntity>();

Reference

EBP.Api.Interfaces.Invoicing.Module.Entities.Colleague Namespace