IColleagueEntity Interface

Colleague Entity

(Commercial/collaborateur)

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("2F235A24-D1AA-4ce8-92AE-502F8701C1C9")]
public interface IColleagueEntity : IColleagueEntityBase, 
	IBusinessEntityBase, ISynchronizableEntityBase, IEntity, IApiEntity, IDisposable, 
	IEquatable<IProxy>

<GuidAttribute("2F235A24-D1AA-4ce8-92AE-502F8701C1C9")>
Public Interface IColleagueEntity
	Inherits IColleagueEntityBase, IBusinessEntityBase, ISynchronizableEntityBase, IEntity, 
	IApiEntity, IDisposable, IEquatable(Of IProxy)

The IColleagueEntity type exposes the following members.

Properties

	Name	Description
	AbsenceFilterDateFrom	Gets or sets the filter event date from
	AbsenceFilterDateFromMember	Gets the filter event date from
	AbsenceFilterDateRange	Gets or sets the absence filter date range.
	AbsenceFilterDateRangeMember	Gets the absence filter date range.
	AbsenceFilterDateTo	Gets or sets the filter event date to
	AbsenceFilterDateToMember	Gets the filter event date to
	Absences	Gets the absences.
	ActiveState	Gets or sets the active state (active, in sleeping, blocked...) List of authorized values in ColleagueActiveState
	ActiveStateMember	Gets the active state (active, in sleeping, blocked...) List of authorized values in ColleagueActiveState
	Address	Gets Colleague Address
	AnalyticAccounting	Gets the analytic accounting members
	AssociatedFiles	Associated Files collection
	CifNif	Gets or sets the CIF/NIF
	CifNifMember	Gets the CIF/NIF
	ColleagueFamilyCaption	Gets the Colleague Family caption (Libellé) (Inherited from IColleagueEntityBase.)
	ColleagueFamilyCaptionMember	Gets the Colleague Family caption (Libellé) (Inherited from IColleagueEntityBase.)
	ColleagueFamilyId	Gets or sets the Colleague Family Id (Code famille) (Inherited from IColleagueEntityBase.)
	ColleagueFamilyIdMember	Gets the Colleague Family Id (Code famille) (Inherited from IColleagueEntityBase.)
	CommissionScaleLines	Gets CommissionScale
	Competences	Gets the competences
	Contact	Get Colleague Contact
	CreatedDate	Gets the Created Date (Inherited from IEntity.)
	CreatedUser	Gets the Created User (Inherited from IEntity.)
	DocumentSerialCaption	Gets the document serial caption
	DocumentSerialCaptionMember	Gets the document serial caption
	DocumentSerialId	Gets or sets the default document serial id to use when creating document
	DocumentSerialIdMember	Gets the default document serial id to use when creating document
	EmailSignature	Gets or sets the RTF email signature
	EmailSignatureClear	Gets or sets the email signature without RTF formmating
	EmailSignatureClearMember	Gets the email signature without RTF formmating
	EmailSignatureMember	Gets the RTF email signature
	EmployeePayrollId	Gets or sets the employee payroll ID
	EmployeePayrollIdMember	Gets the employee payroll ID
	EmployeeRegistrationNumber	Gets or sets the employee registration number.
	EmployeeRegistrationNumberMember	Gets the employee registration number.
	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.)
	EventAutomaticAssign	Gets or sets the event automatic assign (when colleague linked to current user)
	EventAutomaticAssignMember	Gets the event automatic assign (when colleague linked to current user)
	GeographicSectorCaption	Gets the Geographic Sector caption (Nom du secteur) (Inherited from IColleagueEntityBase.)
	GeographicSectorCaptionMember	Gets the Geographic Sector caption (Nom du secteur) (Inherited from IColleagueEntityBase.)
	GeographicSectorId	Gets or sets the Geographic Sector (Code secteur géographique) (Inherited from IColleagueEntityBase.)
	GeographicSectorIdMember	Gets the Geographic Sector (Code secteur géographique) (Inherited from IColleagueEntityBase.)
	Group1	Gets or sets sets the first classification group (Groupe 1) (Inherited from IColleagueEntityBase.)
	Group1Member	Gets/sets the first classification group (Groupe 1) (Inherited from IColleagueEntityBase.)
	Group2	Gets or sets sets the second classification group (Groupe 2) (Inherited from IColleagueEntityBase.)
	Group2Member	Gets/sets the second classification group (Groupe 2) (Inherited from IColleagueEntityBase.)
	HourlyCostPrice	Gets or sets the hourly cost price.
	HourlyCostPriceMember	Gets the hourly cost price.
	Id	Gets or sets Colleague Code (Code commercial/collaborateur) (Inherited from IColleagueEntityBase.)
	IdMember	Gets Colleague Code (Code commercial/collaborateur) (Inherited from IColleagueEntityBase.)
	IrpfRate	Gets or sets the IRPF Rate
	IrpfRateMember	Gets the IRPF Rate
	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.)
	IsSalesperson	Gets or sets if colleague is salesperson (Commercial) (Inherited from IColleagueEntityBase.)
	IsSalespersonMember	Get if colleague is salesperson (Commercial) (Inherited from IColleagueEntityBase.)
	MaximumDiscountRateAllowed	Gets or sets the maximum discount rate (Remise maximum autorisée) (Inherited from IColleagueEntityBase.)
	MaximumDiscountRateAllowedMember	Gets the maximum discount rate (Remise maximum autorisée) (Inherited from IColleagueEntityBase.)
	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.)
	ReadOnly	Gets/Sets if the entity is in read only mode, to preserve from data changing (Inherited from IEntity.)
	ReferenceItemCaption	Gets the reference item caption.
	ReferenceItemCaptionMember	Gets the reference item caption.
	ReferenceItemId	Gets or sets the reference item id.
	ReferenceItemIdMember	Gets the reference item id.
	ReferenceItemSalePriceVatExcluded	Gets the reference item sale price vat excluded.
	ReferenceItemSalePriceVatExcludedMember	Gets the reference item sale price vat excluded.
	SalePriceVatExcluded	Gets or sets the sale price vat excluded.
	SalePriceVatExcludedMember	Gets the sale price vat excluded.
	ScheduleRangeExceptions	Gets the schedule range exceptions
	Silent	Get/Sets if the entity is in silent mode (Inherited from IEntity.)
	States	Gets the entity states (Inherited from IEntity.)
	StorehouseId	Gets or sets the storehouse id used as default value on sales document
	StorehouseIdMember	Gets the storehouse id used as default value on sales document
	UniqueId	Gets or sets the unique Id (Inherited from ISynchronizableEntityBase.)
	UniqueIdMember	Gets the unique Id (Inherited from ISynchronizableEntityBase.)
	UserId	Gets or sets the linked UserId (Code utilisateur) (Inherited from IColleagueEntityBase.)
	UserIdMember	get the linked UserId (Code utilisateur) (Inherited from IColleagueEntityBase.)
	UserName	Get the UserName
	UserNameMember	Get the UserName
	WebSynchronizationInfos	Gets WebSynchronizationInfos

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

Copy

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

Reference

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