 | IDocumentEntityT Interface |
Class representing a document entity
(Client/Prospect)
Namespace: EBP.Api.Interfaces.Invoicing.Module.Entities.DocumentBase
Assembly: EBP.Api.XXX.Interfaces (in EBP.Api.XXX.Interfaces.dll) Version: 1.0.3.0
Syntaxpublic interface IDocumentEntity<T> : IDocumentEntityBase, IInvoicingEntityBase, IBusinessEntityBase, ISynchronizableEntityBase, IEntity, IApiEntity, IDisposable, IEquatable<IProxy> where T : IDocumentLineEntityBase
Type Parameters
- T
- Document line type
The IDocumentEntityT type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AllowNotReferencedItems | Gets whether the non referenced items are allowed in the document (Inherited from IDocumentEntityBase.) |
| AllowSleepingItem | Gets whether sleeping items are allowed (Inherited from IDocumentEntityBase.) |
| AssociatedFiles | Files associated to the document (Inherited from IDocumentEntityBase.) |
| Behavior | Gets the document functionalities (Inherited from IDocumentEntityBase.) |
| CanInsertNotReferencedItem | Gets whether the non referenced items are allowed in the document (Inherited from IDocumentEntityBase.) |
| ConstructionSiteCaption | Gets or sets the construction site caption (Inherited from IDocumentEntityBase.) |
| ConstructionSiteCaptionMember | Gets the construction site caption (Inherited from IDocumentEntityBase.) |
| ConstructionSiteId | Gets or sets the construction site Id (Inherited from IDocumentEntityBase.) |
| ConstructionSiteIdMember | Gets the construction site Id (Inherited from IDocumentEntityBase.) |
| ConstructionSiteStorehouseId | Gets or sets the construction site storehouse Id (Inherited from IDocumentEntityBase.) |
| ConstructionSiteStorehouseIdMember | Gets the construction site storehouse Id (Inherited from IDocumentEntityBase.) |
| CreatedDate |
Gets the Created Date
(Inherited from IEntity.) |
| CreatedUser |
Gets the Created User
(Inherited from IEntity.) |
| DealCaption | Gets or sets the deal caption (Inherited from IDocumentEntityBase.) |
| DealCaptionMember | Gets the deal caption (Inherited from IDocumentEntityBase.) |
| DealId | Gets or sets the deal id (Inherited from IDocumentEntityBase.) |
| DealIdMember | Gets the deal id (Inherited from IDocumentEntityBase.) |
| DispatchedByStorehouse | Gets or sets if Document is dispatched on multiple Storehouses (Inherited from IDocumentEntityBase.) |
| DispatchedByStorehouseMember | Gets if Document is dispatched on multiple Storehouses (Inherited from IDocumentEntityBase.) |
| DocumentDate | Date of the document (Inherited from IDocumentEntityBase.) |
| DocumentDateMember | Date of the document (Inherited from IDocumentEntityBase.) |
| DocumentNumber | Id of the Items Family (Inherited from IDocumentEntityBase.) |
| DocumentNumberMember | Id of the Items Family (Inherited from IDocumentEntityBase.) |
| DocumentSerialId | Gets or sets the document serial id (Inherited from IDocumentEntityBase.) |
| DocumentSerialIdMember | Gets the document serial id (Inherited from IDocumentEntityBase.) |
| DocumentType | Type of the document (E:PutAway - S:Pick - F:Invoice - D:Quote)
(Inherited from IDocumentEntityBase.)Sale document : List of authorized values in SaleDocumentSubTypes Purchase document : List of authorized values in PurchaseDocumentSubTypes Stock document : List of authorized values in StockDocumentSubTypes |
| DocumentTypeMember | Type of the document (E:PutAway - S:Pick - F:Invoice - D:Quote)
(Inherited from IDocumentEntityBase.)Sale document : List of authorized values in SaleDocumentSubTypes Purchase document : List of authorized values in PurchaseDocumentSubTypes Stock document : List of authorized values in StockDocumentSubTypes |
| 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.) |
| GlobalDocumentOrder | Global Document Order used for all kind of documents (stock, invoice ...) (Inherited from IDocumentEntityBase.) |
| GlobalDocumentOrderMember | Global Document Order used for all kind of documents (stock, invoice ...) (Inherited from IDocumentEntityBase.) |
| Hash | Gets the hash. (Inherited from IDocumentEntityBase.) |
| HasNotReferencedItemRight | Gets whether the non referenced items are allowed in the document (Inherited from IDocumentEntityBase.) |
| Id | internal Id for the document (Inherited from IDocumentEntityBase.) |
| IdMember | internal Id for the document (Inherited from IDocumentEntityBase.) |
| IncidentId | Gets or sets the incident Id (Inherited from IDocumentEntityBase.) |
| IncidentIdMember | Gets the incident Id (Inherited from IDocumentEntityBase.) |
| InternalNumberSuffix | Gets or sets the internal number suffix
On opposition to the number suffix, its persisted in database to can order on document number (Inherited from IDocumentEntityBase.) |
| InternalNumberSuffixMember | Gets the internal number suffix
On opposition to the number suffix, its persisted in database to can order on document number (Inherited from IDocumentEntityBase.) |
| 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.) |
| IsPartiallyBlockedItemAllowed | Allow the insertion of partially blocked item (Inherited from IDocumentEntityBase.) |
| Lines | Document Lines collection (Inherited from IDocumentEntityBase.) |
| MaintenanceContractId | Gets or sets the maintenance contract Id (Inherited from IDocumentEntityBase.) |
| MaintenanceContractIdMember | Gets the maintenance contract Id (Inherited from IDocumentEntityBase.) |
| 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) |
| NotesClear | Gets or sets the notes in plain text format. (Notes en texte brut) |
| NotesClearMember | Gets the notes in plain text format. (Notes en texte brut) |
| NotesMember | Gets the notes in RTF format. (Notes) |
| NumberPrefix | Gets or sets the number prefix (Inherited from IDocumentEntityBase.) |
| NumberPrefixMember | Gets the number prefix (Inherited from IDocumentEntityBase.) |
| NumberSuffix | Gets or sets the number suffix (Inherited from IDocumentEntityBase.) |
| NumberSuffixMember | Gets the number suffix (Inherited from IDocumentEntityBase.) |
| 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.) |
| Reference | Gets or sets the document reference (Inherited from IDocumentEntityBase.) |
| ReferenceMember | Gets the document reference (Inherited from IDocumentEntityBase.) |
| Silent |
Get/Sets if the entity is in silent mode
(Inherited from IEntity.) |
| States |
Gets the entity states
(Inherited from IEntity.) |
| StorehouseCaption | Gets or sets the document storehouse caption (Inherited from IDocumentEntityBase.) |
| StorehouseCaptionMember | Gets the document storehouse caption (Inherited from IDocumentEntityBase.) |
| StorehouseId | Reference Storehouse Id (Inherited from IDocumentEntityBase.) |
| StorehouseIdMember | Reference Storehouse Id (Inherited from IDocumentEntityBase.) |
| SubType | Gets the document sub type (Inherited from IDocumentEntityBase.) |
| TotalVolume | Gets or sets the total volume (Inherited from IDocumentEntityBase.) |
| TotalVolumeMember | Gets the total volume (Inherited from IDocumentEntityBase.) |
| TotalWeight | Gets or sets the total weight (Inherited from IDocumentEntityBase.) |
| TotalWeightMember | Gets the total weight (Inherited from IDocumentEntityBase.) |
| Type | Gets the document type (Inherited from IDocumentEntityBase.) |
| UniqueId | Gets or sets the unique Id (Inherited from ISynchronizableEntityBase.) |
| UniqueIdMember | Gets the unique Id (Inherited from ISynchronizableEntityBase.) |
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.) |
| CheckAllStock | Check the stock for all document lines (Inherited from IDocumentEntityBase.) |
| 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.) |
Events| Name | Description | |
|---|---|---|
 | FooterCalculating | Occurs when footer is calculating (Inherited from IDocumentEntityBase.) |
| ItemCreatedFromLine | Occurs when an item is created from a line (Inherited from IDocumentEntityBase.) |
| ItemLoaded | Occurs when an item has been loaded (Inherited from IDocumentEntityBase.) |
| ModeChanged |
Event raised on mode changed
(Inherited from IEntity.) |
See Also