IMaintenanceContractEntity Interface

Maintenance contract entity

(Contrat de maintenance)

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

Syntax

Copy

[GuidAttribute("4F4AD127-0B79-4F88-8515-21E2899FFF35")]
public interface IMaintenanceContractEntity : IMaintenanceContractEntityBase, 
	IInvoicingEntityBase, IBusinessEntityBase, ISynchronizableEntityBase, IEntity, IApiEntity, 
	IDisposable, IEquatable<IProxy>

<GuidAttribute("4F4AD127-0B79-4F88-8515-21E2899FFF35")>
Public Interface IMaintenanceContractEntity
	Inherits IMaintenanceContractEntityBase, IInvoicingEntityBase, IBusinessEntityBase, ISynchronizableEntityBase, 
	IEntity, IApiEntity, IDisposable, IEquatable(Of IProxy)

The IMaintenanceContractEntity type exposes the following members.

Properties

	Name	Description
	AccomplishedCosts	Gets or Sets the accomplished costs
	AccomplishedCostsMember	Gets or Sets the accomplished costs
	AccomplishedDuration	Gets or Sets the accomplished duration
	AccomplishedDurationMember	Gets or Sets the accomplished duration
	AccomplishedGrossMargin	Gets or Sets the accomplished gross margin
	AccomplishedGrossMarginMember	Gets or Sets the accomplished gross margin
	AccomplishedSales	Gets or Sets the accomplished sales
	AccomplishedSalesMember	Gets or Sets the accomplished sales
	Activities	Gets the contract activities
	ArePartsCovered	Gets or sets whether the parts are covered (Inherited from IMaintenanceContractEntityBase.)
	ArePartsCoveredMember	Gets whether the parts are covered (Inherited from IMaintenanceContractEntityBase.)
	AssociatedFiles	Gets the associated Files
	BindCancellationAcknowledgementLetterReportId	Gets or sets the cancellation acknowledgement letter report Id to bind (Inherited from IMaintenanceContractEntityBase.)
	BindCancellationAcknowledgementLetterReportIdMember	Gets the cancellation acknowledgement letter report Id to bind (Inherited from IMaintenanceContractEntityBase.)
	BindContractRenewalLetterReportId	Gets or sets the contract renewal letter report Id to bind (Inherited from IMaintenanceContractEntityBase.)
	BindContractRenewalLetterReportIdMember	Gets the contract renewal letter report Id to bind (Inherited from IMaintenanceContractEntityBase.)
	BindContractReportId	Gets or sets the contract report Id to bind (Inherited from IMaintenanceContractEntityBase.)
	BindContractReportIdMember	Gets the contract report Id to bind (Inherited from IMaintenanceContractEntityBase.)
	BindTacitRenewalLetterReportId	Gets or sets the tacit renewal letter report Id to bind (Inherited from IMaintenanceContractEntityBase.)
	BindTacitRenewalLetterReportIdMember	Gets the tacit renewal letter report Id to bind (Inherited from IMaintenanceContractEntityBase.)
	CancellationAcknowledgementLetterReportId	Gets or sets the cancellation acknowledgement letter report Id (Inherited from IMaintenanceContractEntityBase.)
	CancellationAcknowledgementLetterReportIdMember	Gets the cancellation acknowledgement letter report Id (Inherited from IMaintenanceContractEntityBase.)
	CancellationDate	Gets or sets the cancellation date
	CancellationDateMember	Gets the cancellation date
	CancellationReason	Gets or sets the cancellation reason
	CancellationReasonMember	Gets the cancellation reason
	Caption	Gets or sets the caption (Inherited from IMaintenanceContractEntityBase.)
	CaptionMember	Gets the caption (Inherited from IMaintenanceContractEntityBase.)
	ColleagueId	Gets or sets the colleague Id
	ColleagueIdMember	Gets the colleague Id
	ColleagueLastName	Gets the colleague last name
	ColleagueLastNameMember	Gets the colleague last name
	ConstructionSiteCaption	Gets the construction site caption
	ConstructionSiteCaptionMember	Gets the construction site caption
	ConstructionSiteCustomerId	Gets the construction site contracting authoriy Id
	ConstructionSiteCustomerIdMember	Gets the construction site contracting authoriy Id
	ConstructionSiteDealId	Gets the construction site deal Id
	ConstructionSiteDealIdMember	Gets the construction site deal Id
	ConstructionSiteId	Gets or sets the construction site Id
	ConstructionSiteIdMember	Gets the construction site Id
	ContractFamilyId	Gets or sets the contract family Id (Inherited from IMaintenanceContractEntityBase.)
	ContractFamilyIdMember	Gets the contract family Id (Inherited from IMaintenanceContractEntityBase.)
	ContractLanguage	Gets or sets the contract language (Iso Code)
	ContractLanguageMember	Gets the contract language (Iso Code)
	ContractRenewalLetterReportId	Gets or sets the contract renewal letter report Id (Inherited from IMaintenanceContractEntityBase.)
	ContractRenewalLetterReportIdMember	Gets the contract renewal letter report Id (Inherited from IMaintenanceContractEntityBase.)
	ContractReportId	Gets or sets the contract report Id (Inherited from IMaintenanceContractEntityBase.)
	ContractReportIdMember	Gets the contract report Id (Inherited from IMaintenanceContractEntityBase.)
	ContractTemplateId	Gets or sets the contract template Id
	ContractTemplateIdMember	Gets the contract template Id
	Costs	Gets the extra costs
	CounterAlertActive	Gets or sets Sets if the alert on counter is active (Inherited from IMaintenanceContractEntityBase.)
	CounterAlertActiveMember	Gets/Sets if the alert on counter is active (Inherited from IMaintenanceContractEntityBase.)
	CounterAlertThreshold	Gets or sets Sets the counter alert threshold (Inherited from IMaintenanceContractEntityBase.)
	CounterAlertThresholdMember	Gets/Sets the counter alert threshold (Inherited from IMaintenanceContractEntityBase.)
	CounterType	Gets or sets the counter type List of authorized values in MaintenanceContractCounterType (Inherited from IMaintenanceContractEntityBase.)
	CounterTypeMember	Gets the counter type List of authorized values in MaintenanceContractCounterType (Inherited from IMaintenanceContractEntityBase.)
	CreatedDate	Gets the Created Date (Inherited from IEntity.)
	CreatedUser	Gets the Created User (Inherited from IEntity.)
	CurrencyId	Gets or sets the currency Id
	CurrencyIdMember	Gets the currency Id
	CustomerCurrencyId	Gets the customer currency Id
	CustomerCurrencyIdMember	Gets the customer currency Id
	CustomerId	Gets or sets the customer Id
	CustomerIdMember	Gets the customer Id
	CustomerName	Gets the customer name
	CustomerNameMember	Gets the customer name
	CustomerProducts	Gets the customer products
	DealCaption	Gets the deal caption
	DealCaptionMember	Gets the deal caption
	DealId	Gets or sets the deal Id
	DealIdMember	Gets the deal Id
	Description	Gets or sets the description (Inherited from IMaintenanceContractEntityBase.)
	DescriptionClear	Gets or sets the description clear (Inherited from IMaintenanceContractEntityBase.)
	DescriptionClearMember	Gets the description clear (Inherited from IMaintenanceContractEntityBase.)
	DescriptionMember	Gets the description (Inherited from IMaintenanceContractEntityBase.)
	DuplicateContractWhenRenewal	Gets or sets whether the contract must be duplicate when there is a renewal (Inherited from IMaintenanceContractEntityBase.)
	DuplicateContractWhenRenewalMember	Gets whether the contract must be duplicate when there is a renewal (Inherited from IMaintenanceContractEntityBase.)
	EndDate	Gets or sets the end date
	EndDateMember	Gets the end date
	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.)
	EventTemplateEventTypeId	Gets the event template event type Id (Inherited from IMaintenanceContractEntityBase.)
	EventTemplateEventTypeIdMember	Gets the event template event type Id (Inherited from IMaintenanceContractEntityBase.)
	EventToForesee	Gets or sets whether an event must be foreseen (Inherited from IMaintenanceContractEntityBase.)
	EventToForeseeMember	Gets whether an event must be foreseen (Inherited from IMaintenanceContractEntityBase.)
	ExceedingCount	Gets or sets the exceeding count
	ExceedingCountMember	Gets the exceeding count
	FilterEventDateFrom	Gets or sets the filter event date from
	FilterEventDateFromMember	Gets the filter event date from
	FilterEventDateRange	Gets or sets the filter event date range List of authorized values in DatesFilterValues and in the custom periods which are in the options entity
	FilterEventDateRangeMember	Gets the filter event date range List of authorized values in DatesFilterValues and in the custom periods which are in the options entity
	FilterEventDateTo	Gets or sets the filter event date to
	FilterEventDateToMember	Gets the filter event date to
	Id	Gets or sets the id
	IdMember	Gets the id
	IncidentCount	Gets or sets the incident count
	IncidentCountMember	Gets the incident count
	Incidents	Gets the incidents linked with this contract
	IncludePurchaseDocumentsInCosts	Gets or sets whether the purchase documents will be included in costs
	IncludePurchaseDocumentsInCostsMember	Gets whether the purchase documents will be included in costs
	IncludeStockDocumentsInCosts	Gets or sets whether the stock documents will be included in costs
	IncludeStockDocumentsInCostsMember	Gets whether the stock documents will be included in costs
	InitialCounterNumber	Gets or sets the initial number for counter (Inherited from IMaintenanceContractEntityBase.)
	InitialCounterNumberMember	Gets the initial number for counter (Inherited from IMaintenanceContractEntityBase.)
	InterventionAddressDescription	Gets the intervention address description
	InterventionAddressDescriptionMember	Gets the intervention address description
	InterventionAddressId	Gets or sets the intervention address id
	InterventionAddressIdExists	Gets if the intervention address id exists
	InterventionAddressIdExistsMember	Gets if the intervention address id exists
	InterventionAddressIdMember	Gets the intervention address id
	InterventionPeriodicity	Gets the intervention periodicity (Inherited from IMaintenanceContractEntityBase.)
	InvoiceContentLines	Gets the invoice content lines (Inherited from IMaintenanceContractEntityBase.)
	InvoiceContentType	Gets or sets the invoice content type List of authorized values in MaintenanceContractInvoiceContentType (Inherited from IMaintenanceContractEntityBase.)
	InvoiceContentTypeMember	Gets the invoice content type List of authorized values in MaintenanceContractInvoiceContentType (Inherited from IMaintenanceContractEntityBase.)
	InvoicingAddress	Gets the invoicing adress
	InvoicingAddressId	Gets or sets the invoicing address Id
	InvoicingAddressIdExists	Gets if the invoicing address Id exists
	InvoicingAddressIdExistsMember	Gets if the invoicing address Id exists
	InvoicingAddressIdMember	Gets the invoicing address Id
	InvoicingContact	Gets the invoicing contact
	InvoicingContactId	Gets or sets the invoicing contact Id
	InvoicingContactIdMember	Gets the invoicing contact Id
	InvoicingCustomerCurrencyId	Gets the invoicing customer currency Id
	InvoicingCustomerCurrencyIdMember	Gets the invoicing customer currency Id
	InvoicingCustomerId	Gets or sets the invoicing customer Id
	InvoicingCustomerIdMember	Gets the invoicing customer Id
	InvoicingCustomerName	Gets the invoicing customer name
	InvoicingCustomerNameMember	Gets the invoicing customer name
	InvoicingVatIncluded	Gets or sets whether the invoicing is with vat included (Inherited from IMaintenanceContractEntityBase.)
	InvoicingVatIncludedMember	Gets whether the invoicing is with vat included (Inherited from IMaintenanceContractEntityBase.)
	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.)
	IsLabourCovered	Gets or sets whether the labour is covered (Inherited from IMaintenanceContractEntityBase.)
	IsLabourCoveredMember	Gets whether the labour is covered (Inherited from IMaintenanceContractEntityBase.)
	IsTravelCovered	Gets or sets whether the travel is covered (Inherited from IMaintenanceContractEntityBase.)
	IsTravelCoveredMember	Gets whether the travel is covered (Inherited from IMaintenanceContractEntityBase.)
	LabourDuration	Gets or sets the labout duration (in month) (Inherited from IMaintenanceContractEntityBase.)
	LabourDurationMember	Gets the labout duration (in month) (Inherited from IMaintenanceContractEntityBase.)
	LastEventGeneratedDate	Gets or sets the last event generated date
	LastEventGeneratedDateMember	Gets the last event generated date
	LastRenewalDate	Gets or sets the last renewal date
	LastRenewalDateMember	Gets the last renewal date
	MailBeforeEvent	Gets or sets whether a mail must be sent before an event (Inherited from IMaintenanceContractEntityBase.)
	MailBeforeEventMember	Gets whether a mail must be sent before an event (Inherited from IMaintenanceContractEntityBase.)
	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.)
	NeedToUpdateAnalysis	Gets or sets whether the analysis has to be updated
	NeedToUpdateAnalysisMember	Gets whether the analysis has to be updated
	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.)
	OriginContractId	Gets or sets the origin contract Id (when the contract has been renewal)
	OriginContractIdMember	Gets the origin contract Id (when the contract has been renewal)
	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.)
	PartsDuration	Gets or sets the parts duration (in month) (Inherited from IMaintenanceContractEntityBase.)
	PartsDurationMember	Gets the parts duration (in month) (Inherited from IMaintenanceContractEntityBase.)
	PeriodicInvoicingId	Gets or sets the periodic invoicing Id (Inherited from IMaintenanceContractEntityBase.)
	PeriodicInvoicingIdMember	Gets the periodic invoicing Id (Inherited from IMaintenanceContractEntityBase.)
	PeriodicInvoicingSettingsEndDate	Gets the periodic invoicing settings end date
	PeriodicInvoicingSettingsEndDateMember	Gets the periodic invoicing settings end date
	PeriodicInvoicingSettingsStartDate	Gets the periodic invoicing settings start date
	PeriodicInvoicingSettingsStartDateMember	Gets the periodic invoicing settings start date
	PeriodicInvoicingStartDate	Gets or sets the periodic invoicing start date
	PeriodicInvoicingStartDateMember	Gets the periodic invoicing start date
	PredictedCosts	Gets or Sets the predicted costs
	PredictedCostsMember	Gets or Sets the predicted costs
	PredictedDuration	Gets or Sets the predicted duration
	PredictedDurationMember	Gets or Sets the predicted duration
	PredictedGrossMargin	Gets or Sets the predicted gross margin
	PredictedGrossMarginMember	Gets or Sets the predicted gross margin
	PredictedPeriodicInvoicingAmount	Gets or sets the predicted periodic invoicing amount
	PredictedPeriodicInvoicingAmountMember	Gets the predicted periodic invoicing amount
	PredictedSales	Gets or Sets the predicted sales
	PredictedSalesMember	Gets or Sets the predicted sales
	ProfitsOnCosts	Gets or Sets the profits on costs
	ProfitsOnCostsMember	Gets or Sets the profits on costs
	ProfitsOnDuration	Gets or Sets the profits on duration
	ProfitsOnDurationMember	Gets or Sets the profits on duration
	ProfitsOnGrossMargin	Gets or Sets the profits on gross margin
	ProfitsOnGrossMarginMember	Gets or Sets the profits on gross margin
	ProfitsOnSales	Gets or Sets the profits on sales
	ProfitsOnSalesMember	Gets or Sets the profits on sales
	ProposeRenewalDate	Gets or sets the propose renewal date
	ProposeRenewalDateMember	Gets the propose renewal date
	PurchaseDocuments	Gets the PurchaseDocuments
	PurchaseDocumentsCustomized	Gets the purchase documents customized
	ReadOnly	Gets/Sets if the entity is in read only mode, to preserve from data changing (Inherited from IEntity.)
	RemainingCounterNumber	Gets or sets the remaining number for counter
	RemainingCounterNumberMember	Gets the remaining number for counter
	RenewalUpdatingRate	Gets or sets the updating rate used in contract renewal
	RenewalUpdatingRateMember	Gets the updating rate used in contract renewal
	ResourcesCost	Gets the resources cost
	SaleDocuments	Gets the SaleDocuments
	ScheduleEventCount	Gets or sets the schedule event count
	ScheduleEventCountMember	Gets the schedule event count
	ScheduleEvents	Gets the schedule events
	ScheduleEventTemplateId	Gets or sets the schedule event template Id (Inherited from IMaintenanceContractEntityBase.)
	ScheduleEventTemplateIdMember	Gets the schedule event template Id (Inherited from IMaintenanceContractEntityBase.)
	ScheduleEventTypeId	Gets or sets the schedule event type Id (Inherited from IMaintenanceContractEntityBase.)
	ScheduleEventTypeIdMember	Gets the schedule event type Id (Inherited from IMaintenanceContractEntityBase.)
	Silent	Get/Sets if the entity is in silent mode (Inherited from IEntity.)
	StartDate	Gets or sets the start date
	StartDateMember	Gets the start date
	States	Gets the entity states (Inherited from IEntity.)
	Status	Gets or sets the status List of authorized values in MaintenanceContractState
	StatusMember	Gets the status List of authorized values in MaintenanceContractState
	StockDocuments	Gets the stock documents
	StockDocumentsCustomized	Gets the stock documents customized
	TacitRenewal	Gets or sets whether there is a tacit renewal (Inherited from IMaintenanceContractEntityBase.)
	TacitRenewalLetterReportId	Gets or sets the tacit renewal letter report Id (Inherited from IMaintenanceContractEntityBase.)
	TacitRenewalLetterReportIdMember	Gets the tacit renewal letter report Id (Inherited from IMaintenanceContractEntityBase.)
	TacitRenewalMember	Gets whether there is a tacit renewal (Inherited from IMaintenanceContractEntityBase.)
	TimeEvents	Gets the time events.
	TransferRemainingCounterWhenRenewal	Gets or sets whether the remaining counter will be transfered when renewal
	TransferRemainingCounterWhenRenewalMember	Gets whether the remaining counter will be transfered when renewal
	TravelDuration	Gets or sets the travel duration (in month) (Inherited from IMaintenanceContractEntityBase.)
	TravelDurationMember	Gets the travel duration (in month) (Inherited from IMaintenanceContractEntityBase.)
	TravelExpenseCaption	Gets the travel expense caption
	TravelExpenseCaptionMember	Gets the travel expense caption
	TravelExpenseId	Gets or sets the travel expense Id
	TravelExpenseIdMember	Gets the travel expense Id
	UniqueId	Gets or sets the unique Id (Inherited from ISynchronizableEntityBase.)
	UniqueIdMember	Gets the unique Id (Inherited from ISynchronizableEntityBase.)
	UseContractAddressInDeliveryAdressInvoice	Gets or sets whether we must use the contract's address in the delivery address of the generated invoices (Inherited from IMaintenanceContractEntityBase.)
	UseContractAddressInDeliveryAdressInvoiceMember	Gets whether we must use the contract's address in the delivery address of the generated invoices (Inherited from IMaintenanceContractEntityBase.)

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 IMaintenanceContractEntity type can be instantiated with EBP.Api.Utils<TExtension>.GetInterface<T>

Copy

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

Reference

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