IDealEntity Interface

Deal entity class

(Affaire)

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

Syntax

Copy

[GuidAttribute("29C07ABA-A1B7-4573-8C55-C2551C25D61D")]
public interface IDealEntity : IDealEntityBase, 
	IInvoicingEntityBase, IBusinessEntityBase, ISynchronizableEntityBase, IEntity, IApiEntity, 
	IDisposable, IEquatable<IProxy>

<GuidAttribute("29C07ABA-A1B7-4573-8C55-C2551C25D61D")>
Public Interface IDealEntity
	Inherits IDealEntityBase, IInvoicingEntityBase, IBusinessEntityBase, ISynchronizableEntityBase, 
	IEntity, IApiEntity, IDisposable, IEquatable(Of IProxy)

The IDealEntity type exposes the following members.

Properties

	Name	Description
	AccomplishedCosts	Gets or Sets the accomplished costs (Inherited from IDealEntityBase.)
	AccomplishedCostsMember	Gets or Sets the accomplished costs (Inherited from IDealEntityBase.)
	AccomplishedDuration	Gets or Sets the accomplished duration (Inherited from IDealEntityBase.)
	AccomplishedDurationMember	Gets or Sets the accomplished duration (Inherited from IDealEntityBase.)
	AccomplishedGrossMargin	Gets or Sets the accomplished gross margin (Inherited from IDealEntityBase.)
	AccomplishedGrossMarginMember	Gets or Sets the accomplished gross margin (Inherited from IDealEntityBase.)
	AccomplishedSales	Gets or Sets the accomplished sales (Inherited from IDealEntityBase.)
	AccomplishedSalesMember	Gets or Sets the accomplished sales (Inherited from IDealEntityBase.)
	AccountingYearId	Gets or sets the accounting year Id (Inherited from IDealEntityBase.)
	AccountingYearIdMember	Gets the accounting year Id (Inherited from IDealEntityBase.)
	ActualTreasury	Gets or sets the actual treasury. (Inherited from IDealEntityBase.)
	ActualTreasuryMember	Gets the actual treasury. (Inherited from IDealEntityBase.)
	AnalyticAccounting	Gets the analytic accounting members (Inherited from IDealEntityBase.)
	AssociatedFiles	Files associated to the document (Inherited from IDealEntityBase.)
	Caption	Gets or Sets the caption (Libellé)
	CaptionMember	Gets or Sets the caption (Libellé)
	Colleagues	Gets or Sets the associated Colleagues (Inherited from IDealEntityBase.)
	ConstructionSites	Gets the construction sites.
	CreatedDate	Gets the Created Date (Inherited from IEntity.)
	CreatedUser	Gets the Created User (Inherited from IEntity.)
	CustomerCommitmentBalanceDues	Gets or sets the customer commitment balance dues. (Inherited from IDealEntityBase.)
	CustomerCommitmentBalanceDuesMember	Gets the customer commitment balance dues. (Inherited from IDealEntityBase.)
	Customers	Gets or Sets the associated customers or prospects (Inherited from IDealEntityBase.)
	DealDate	Gets or Sets the date (Date)
	DealDateMember	Gets or Sets the date (Date)
	DealOptionsBase	Gets the deal options base (Inherited from IDealEntityBase.)
	DealState	Gets or Sets the state List of authorized values (StateX) in IDealGeneralOptionsComplexEntityMember (État)
	DealStateMember	Gets or Sets the state List of authorized values (StateX) in IDealGeneralOptionsComplexEntityMember (État)
	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.)
	Events	Gets the events. (Inherited from IDealEntityBase.)
	ExtraCosts	Gets or Sets the extra costs (Inherited from IDealEntityBase.)
	ExtraCostsPerUnit	Gets or Sets the costs per unit list (Inherited from IDealEntityBase.)
	Id	Gets or Sets the id (Code) (Inherited from IDealEntityBase.)
	IdMember	Gets or Sets the id (Code) (Inherited from IDealEntityBase.)
	Incidents	Gets the incidents (Inherited from IDealEntityBase.)
	InvoiceScheduleEvent	Gets or sets whether to invoice schedule event by default (Inherited from IDealEntityBase.)
	InvoiceScheduleEventMember	Gets whether to invoice schedule event by default (Inherited from IDealEntityBase.)
	InvoiceScheduleTimeEvent	Gets or sets whether to invoice schedule time event by default (Inherited from IDealEntityBase.)
	InvoiceScheduleTimeEventMember	Gets whether to invoice schedule time event by default (Inherited from IDealEntityBase.)
	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.)
	Items	Gets or set the items (Inherited from IDealEntityBase.)
	MaintenanceContractId	Gets or sets the maintenance contract Id (Code contrat) (Inherited from IDealEntityBase.)
	MaintenanceContractIdMember	Gets the maintenance contract Id (Code contrat) (Inherited from IDealEntityBase.)
	MaintenanceContracts	Gets the maintenance contracts (Inherited from IDealEntityBase.)
	Members	List of the members. It allows to acces to members with the name (Inherited from IEntity.)
	MiscContacts	Gets the misc contacts (not attached to customer or supplier) (Inherited from IDealEntityBase.)
	Mode	Gets the entity mode (Inherited from IEntity.)
	ModifiedDate	Gets the Modified Date (Inherited from IEntity.)
	ModifiedUser	Gets the Modified User (Inherited from IEntity.)
	Notes	Gets or sets the notes in RTF format. (Notes) (Inherited from IBusinessEntityBase.)
	NotesClear	Gets or sets the notes in plain text format. (Notes en texte brut) (Inherited from IBusinessEntityBase.)
	NotesClearMember	Gets the notes in plain text format. (Notes en texte brut) (Inherited from IBusinessEntityBase.)
	NotesMember	Gets the notes in RTF format. (Notes) (Inherited from IBusinessEntityBase.)
	OtherCosts	Gets or sets the other costs. (Inherited from IDealEntityBase.)
	OtherCostsMember	Gets the other costs. (Inherited from IDealEntityBase.)
	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.)
	PredictedCosts	Gets or Sets the predicted costs (Inherited from IDealEntityBase.)
	PredictedCostsMember	Gets or Sets the predicted costs (Inherited from IDealEntityBase.)
	PredictedDuration	Gets or Sets the predicted duration (Inherited from IDealEntityBase.)
	PredictedDurationMember	Gets or Sets the predicted duration (Inherited from IDealEntityBase.)
	PredictedGrossMargin	Gets or Sets the predicted gross margin (Inherited from IDealEntityBase.)
	PredictedGrossMarginMember	Gets or Sets the predicted gross margin (Inherited from IDealEntityBase.)
	PredictedSales	Gets or Sets the predicted sales (Inherited from IDealEntityBase.)
	PredictedSalesMember	Gets or Sets the predicted sales (Inherited from IDealEntityBase.)
	ProfitsOnCosts	Gets or Sets the profits on costs (Inherited from IDealEntityBase.)
	ProfitsOnCostsMember	Gets or Sets the profits on costs (Inherited from IDealEntityBase.)
	ProfitsOnDuration	Gets or Sets the profits on duration (Inherited from IDealEntityBase.)
	ProfitsOnDurationMember	Gets or Sets the profits on duration (Inherited from IDealEntityBase.)
	ProfitsOnGrossMargin	Gets or Sets the profits on gross margin (Inherited from IDealEntityBase.)
	ProfitsOnGrossMarginMember	Gets or Sets the profits on gross margin (Inherited from IDealEntityBase.)
	ProfitsOnSales	Gets or Sets the profits on sales (Inherited from IDealEntityBase.)
	ProfitsOnSalesMember	Gets or Sets the profits on sales (Inherited from IDealEntityBase.)
	PurchaseActivities	Gets the purchase activities (Inherited from IDealEntityBase.)
	PurchaseCommitments	Gets the purchase commitments (Inherited from IDealEntityBase.)
	PurchasesDocuments	Gets or Sets the associated purchases lines (Inherited from IDealEntityBase.)
	PurchasesSettlements	Gets or Sets the purchases settlements (Inherited from IDealEntityBase.)
	ReadOnly	Gets/Sets if the entity is in read only mode, to preserve from data changing (Inherited from IEntity.)
	ResourceCosts	Gets the resources cost. (Inherited from IDealEntityBase.)
	SaleActivities	Gets the sale activities (Inherited from IDealEntityBase.)
	SaleCommitments	Gets the sale commitments (Inherited from IDealEntityBase.)
	SalesDocuments	Gets or Sets the associated sales documents (Inherited from IDealEntityBase.)
	SalesSettlements	Gets or Sets the sales settlements (Inherited from IDealEntityBase.)
	Silent	Get/Sets if the entity is in silent mode (Inherited from IEntity.)
	States	Gets the entity states (Inherited from IEntity.)
	StockDocuments	Gets the associated stock documents. (Inherited from IDealEntityBase.)
	SubContractorCommitmentBalanceDues	Gets or sets the sub contractor commitment balance dues. (Inherited from IDealEntityBase.)
	SubContractorCommitmentBalanceDuesMember	Gets the sub contractor commitment balance dues. (Inherited from IDealEntityBase.)
	SupplierCommitmentBalanceDues	Gets or sets the supplier commitment balance dues. (Inherited from IDealEntityBase.)
	SupplierCommitmentBalanceDuesMember	Gets the supplier commitment balance dues. (Inherited from IDealEntityBase.)
	Suppliers	Gets or Sets the associated Suppliers (Inherited from IDealEntityBase.)
	TimeEvents	Gets the time events. (Inherited from IDealEntityBase.)
	TreasuryBalanceDue	Gets or sets the treasury balance due. (Inherited from IDealEntityBase.)
	TreasuryBalanceDueMember	Gets the treasury balance due. (Inherited from IDealEntityBase.)
	UniqueId	Gets or sets the unique Id (Inherited from ISynchronizableEntityBase.)
	UniqueIdMember	Gets the unique Id (Inherited from ISynchronizableEntityBase.)

Top

Methods

	Name	Description
	AddColleague	Add colleague to the deal (Inherited from IDealEntityBase.)
	AddCustomer	Add customer to the deal (Inherited from IDealEntityBase.)
	AddSupplier	Add supplier to the deal (Inherited from IDealEntityBase.)
	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.)
	CreateInvoiceFromEvents	Creates invoice from events. (Inherited from IDealEntityBase.)
	CreateInvoiceFromEventsAndResources	Creates invoice from events and resources. (Inherited from IDealEntityBase.)
	CreateInvoiceFromTimeEvents	Creates invoice from time events. (Inherited from IDealEntityBase.)
	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.)
	EnsureRescourceCostsUpToDate	Ensures the resource costs are up to date. (Inherited from IDealEntityBase.)
	GetExtension	Gets the extension. (Inherited from IApiEntity.)
	GetInvoiceColleagueId	Gets the invoice colleague id. (Inherited from IDealEntityBase.)
	GetInvoiceCustomerId	Gets the invoice customer id. (Inherited from IDealEntityBase.)
	Load	Method for loading the entity (Inherited from IEntity.)
	RefreshStatisticsDatas	Refresh statistics datas (Inherited from IDealEntityBase.)
	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.)
	UpdateDatas	Update the deal Clear all collections and rebuild them with new modification (Inherited from IDealEntityBase.)

Top

Events

	Name	Description
	CreatingInvoiceFromSchedule	Event raised when creating invoice from schedule (Inherited from IDealEntityBase.)
	DealUpdated	Event raised when deal datas have been updated (Inherited from IDealEntityBase.)
	ModeChanged	Event raised on mode changed (Inherited from IEntity.)
	StatisticsDataTableUpdated	Event raised when statistics data table has been updated (Inherited from IDealEntityBase.)

Top

Remarks

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

Copy

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

Reference

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