IActivityEntity Interface

Activity entity

(Activité)

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

Syntax

Copy

[GuidAttribute("73C58402-F569-4B75-AD1A-4EAF0C1BDD4F")]
public interface IActivityEntity : IInvoicingEntityBase, 
	IBusinessEntityBase, ISynchronizableEntityBase, IEntity, IApiEntity, IDisposable, 
	IEquatable<IProxy>

<GuidAttribute("73C58402-F569-4B75-AD1A-4EAF0C1BDD4F")>
Public Interface IActivityEntity
	Inherits IInvoicingEntityBase, IBusinessEntityBase, ISynchronizableEntityBase, IEntity, 
	IApiEntity, IDisposable, IEquatable(Of IProxy)

The IActivityEntity type exposes the following members.

Properties

	Name	Description
	AssociatedFiles	Associated Files collection
	Caption	Gets or sets the caption. (Libellé)
	CaptionMember	Gets the caption. (Libellé)
	Category	Gets or sets the Category. List of authorized values in ActivityCategoryType (Catégorie)
	CategoryMember	Gets the Category. List of authorized values in ActivityCategoryType (Catégorie)
	ColleagueFirstName	Gets the first name of the colleague. (Prénom)
	ColleagueFirstNameMember	Gets the first name of the colleague. (Prénom)
	ColleagueId	Gets or sets the colleague id. (Code commercial/collaborateur)
	ColleagueIdMember	Gets the colleague id. (Code commercial/collaborateur)
	ColleagueLabel	Gets or sets the colleague label
	ColleagueLabelMember	Gets the colleague label
	ColleagueLastName	Gets the last name of the colleague (Nom)
	ColleagueLastNameMember	Gets the last name of the colleague (Nom)
	ConstructionSiteCaption	Gets the construction site caption (Libellé)
	ConstructionSiteCaptionMember	Gets the construction site caption (Libellé)
	ConstructionSiteCustomerId	Gets the construction site contracting authoriy Id (Code client)
	ConstructionSiteCustomerIdMember	Gets the construction site contracting authoriy Id (Code client)
	ConstructionSiteDealId	Gets the construction site deal Id (Code Affaire)
	ConstructionSiteDealIdMember	Gets the construction site deal Id (Code Affaire)
	ConstructionSiteId	Gets or sets the construction site Id (Code du projet)
	ConstructionSiteIdMember	Gets the construction site Id (Code du projet)
	Contact	Gets the contact.
	ContactId	Gets or sets the Contact identifier (Identifiant du contact)
	ContactIdMember	Gets the Contact identifier (Identifiant du contact)
	CreatedDate	Gets the Created Date (Inherited from IEntity.)
	CreatedUser	Gets the Created User (Inherited from IEntity.)
	CreatorColleagueFirstName	Gets the first name of the Creator colleague. (Prénom)
	CreatorColleagueFirstNameMember	Gets the first name of the Creator colleague. (Prénom)
	CreatorColleagueId	Gets or sets the Creator colleague id. (Saisi par)
	CreatorColleagueIdMember	Gets the Creator colleague id. (Saisi par)
	CreatorColleagueLabel	Gets or sets the Creator colleague label
	CreatorColleagueLabelMember	Gets the Creator colleague label
	CreatorColleagueLastName	Gets the last name of the Creator colleague (Nom)
	CreatorColleagueLastNameMember	Gets the last name of the Creator colleague (Nom)
	CustomerId	Gets or sets the customer id. (Code client)
	CustomerIdMember	Gets the customer id. (Code client)
	CustomerName	Gets or sets the name of the customer. (Nom du client)
	CustomerNameMember	Gets the name of the customer. (Nom du client)
	DealCaption	Gets the deal caption. (Libellé)
	DealCaptionMember	Gets the deal caption. (Libellé)
	DealId	Gets or sets the deal id. (Code Affaire)
	DealIdMember	Gets the deal id. (Code Affaire)
	DocumentType	Gets or sets the type of the document. List of authorized values in DocumentTypes (Type de document)
	DocumentTypeMember	Gets the type of the document. List of authorized values in DocumentTypes (Type de document)
	EndDateTime	Gets or sets the end date time. (Fin)
	EndDateTimeMember	Gets the end date time. (Fin)
	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.)
	EventDisplayType	Gets the event display type. (Affichage)
	EventDisplayTypeMember	Gets the event display type. (Affichage)
	EventTypeId	Gets or sets the event type id. (Type d'évènement)
	EventTypeIdMember	Gets the event type id. (Type d'évènement)
	Id	Id of the data (Code)
	IdMember	Id of the data (Code)
	IncidentCaption	Gets the incident caption. (Libellé)
	IncidentCaptionMember	Gets the incident caption. (Libellé)
	IncidentCustomerId	Gets the incident customer id (Code client)
	IncidentCustomerIdMember	Gets the incident customer id (Code client)
	IncidentId	Gets or sets the incident Id (Code suivi incident)
	IncidentIdMember	Gets the incident Id (Code suivi incident)
	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.)
	MaintenanceContractCaption	Gets the MaintenanceContract caption. (Libellé)
	MaintenanceContractCaptionMember	Gets the MaintenanceContract caption. (Libellé)
	MaintenanceContractCustomerId	Gets the MaintenanceContract customer id (Code client)
	MaintenanceContractCustomerIdMember	Gets the MaintenanceContract customer id (Code client)
	MaintenanceContractId	Gets or sets the maitenance contract Id (Code contrat)
	MaintenanceContractIdMember	Gets the maitenance contract Id (Code contrat)
	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.)
	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.)
	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.)
	PurchaseDocumentConstructionSiteId	The purchase document ExecutionQuote (Code du projet)
	PurchaseDocumentConstructionSiteIdMember	The purchase document ExecutionQuote (Code du projet)
	PurchaseDocumentDealId	The purchase document dealId (Code Affaire)
	PurchaseDocumentDealIdMember	The purchase document dealId (Code Affaire)
	PurchaseDocumentId	Gets or sets the purchase document id. (Code document d'achat)
	PurchaseDocumentIdMember	Gets the purchase document id. (Code document d'achat)
	ReadOnly	Gets/Sets if the entity is in read only mode, to preserve from data changing (Inherited from IEntity.)
	ReminderLetterId	Gets or sets the reminder letter id (Code de fiche de relance)
	ReminderLetterIdMember	Gets the reminder letter id (Code de fiche de relance)
	SaleDocumentConstructionSiteId	The sale document ExecutionQuote (Code du projet)
	SaleDocumentConstructionSiteIdMember	The sale document ExecutionQuote (Code du projet)
	SaleDocumentCustomerId	Gets the sale document customer id (Code client)
	SaleDocumentCustomerIdMember	Gets the sale document customer id (Code client)
	SaleDocumentDealId	The sale document dealId (Code Affaire)
	SaleDocumentDealIdMember	The sale document dealId (Code Affaire)
	SaleDocumentId	Gets or sets the sale document id. (Code document de vente)
	SaleDocumentIdMember	Gets the sale document id. (Code document de vente)
	ScheduleEventId	Gets or sets the schedule event id (Identifiant de l'évènement)
	ScheduleEventIdMember	Gets the schedule event id (Identifiant de l'évènement)
	Silent	Get/Sets if the entity is in silent mode (Inherited from IEntity.)
	StartDateTime	Gets or sets the start date time. (Début)
	StartDateTimeMember	Gets the start date time. (Début)
	State	Gets or sets the state. (Etat)
	StateMember	Gets the state. (Etat)
	States	Gets the entity states (Inherited from IEntity.)
	SupplierId	Gets or sets the supplier id. (Code fournisseur)
	SupplierIdMember	Gets the supplier id. (Code fournisseur)
	SupplierName	Gets or sets the name of the supplier. (Nom du fournisseur)
	SupplierNameMember	Gets the name of the supplier. (Nom du fournisseur)
	ThirdName	Gets or sets the third name
	ThirdNameMember	Gets the third name
	UniqueId	Gets or sets the unique Id (Inherited from ISynchronizableEntityBase.)
	UniqueIdMember	Gets the unique Id (Inherited from ISynchronizableEntityBase.)

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.)
	IsActivityReadOnlyBecauseOfCategory	Gets whether activity is read-only because of it's category
	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
	AddressContactChanged	Occurs when the address has been modified
	ModeChanged	Event raised on mode changed (Inherited from IEntity.)

Top

Remarks

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

Copy

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

Reference

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