Click or drag to resize

IGiftVoucherEntity Interface

Gift voucher entity

Namespace:  EBP.Api.Interfaces.Invoicing.Module.Entities.Pos
Assembly:  EBP.Api.XXX.Interfaces (in EBP.Api.XXX.Interfaces.dll) Version: 1.0.3.0
Syntax
public interface IGiftVoucherEntity : IInvoicingEntityBase, 
	IBusinessEntityBase, ISynchronizableEntityBase, IEntity, IApiEntity, IDisposable, 
	IEquatable<IProxy>

The IGiftVoucherEntity type exposes the following members.

Properties
  NameDescription
Public propertyActivated
Gets or sets whether the gift voucher is activated
Public propertyActivatedMember
Gets whether the gift voucher is activated
Public propertyActivationDate
Gets or sets the activation date
Public propertyActivationDateMember
Gets the activation date
Public propertyCashValue
Gets or sets the cash value
Public propertyCashValueMember
Gets the cash value
Public propertyCreatedDate
Gets the Created Date
(Inherited from IEntity.)
Public propertyCreatedUser
Gets the Created User
(Inherited from IEntity.)
Public propertyEntityCaption
Gets the caption of the current entity, using the content
(Inherited from IEntity.)
Public propertyEntityLabel
Gets the entity Label
(Inherited from IEntity.)
Public propertyErrors
Gets the collection of errors
(Inherited from IEntity.)
Public propertyExpiryDate
Gets or sets the expiry date
Public propertyExpiryDateMember
Gets the expiry date
Public propertyGiftVoucherReturningChangeAmount
Pos returning change amount by gift voucher
Public propertyGiftVoucherReturningChangeAmountMember
Pos returning change amount by gift voucher
Public propertyGiveChangeDocumentId
Gets or sets the give change document Id
Public propertyGiveChangeDocumentIdMember
Gets the give change document Id
Public propertyId
Gets or sets the id
Public propertyIdMember
Gets the id
Public propertyIsDeleted
Gets if the mode matches a deleted mode
(Inherited from IEntity.)
Public propertyIsEmptyLine
Indicates if the entity is an empty line of an entity collection (created in auto following the entityCollection options)
(Inherited from IEntity.)
Public propertyIsSoldWithoutDocument
Gets or sets whether gift voucher has been sold without document (manually sold from item entry form, for gift voucher sold in another application).
Public propertyIsSoldWithoutDocumentMember
Gets whether gift voucher has been sold without document (manually sold from item entry form, for gift voucher sold in another application).
Public propertyItemId
Gets or sets the item Id
Public propertyItemIdMember
Gets the item Id
Public propertyMembers
List of the members. It allows to acces to members with the name
(Inherited from IEntity.)
Public propertyMode
Gets the entity mode
(Inherited from IEntity.)
Public propertyModifiedDate
Gets the Modified Date
(Inherited from IEntity.)
Public propertyModifiedUser
Gets the Modified User
(Inherited from IEntity.)
Public propertyNotes

Gets or sets the notes in RTF format.

(Notes)

(Inherited from IBusinessEntityBase.)
Public propertyNotesClear

Gets or sets the notes in plain text format.

(Notes en texte brut)

(Inherited from IBusinessEntityBase.)
Public propertyNotesClearMember

Gets the notes in plain text format.

(Notes en texte brut)

(Inherited from IBusinessEntityBase.)
Public propertyNotesMember

Gets the notes in RTF format.

(Notes)

(Inherited from IBusinessEntityBase.)
Public propertyOwnerEntity
Gets the main entity that own all this items/collection
(Inherited from IEntity.)
Public propertyParent
Gets the parent entity collection, that own this item
(Inherited from IEntity.)
Public propertyReadOnly
Gets/Sets if the entity is in read only mode, to preserve from data changing
(Inherited from IEntity.)
Public propertyReturningChangeAmount
Pos returning change amount by cash
Public propertyReturningChangeAmountMember
Pos returning change amount by cash
Public propertySaleDocumentId
Gets or sets the sale document Id
Public propertySaleDocumentIdMember
Gets the sale document Id
Public propertySaleDocumentLineId
Gets or sets the sale document line Id
Public propertySaleDocumentLineIdMember
Gets the sale document line Id
Public propertySettlementDocumentId
Gets or sets the settlement document Id
Public propertySettlementDocumentIdMember
Gets the settlement document Id
Public propertySilent
Get/Sets if the entity is in silent mode
(Inherited from IEntity.)
Public propertyStates
Gets the entity states
(Inherited from IEntity.)
Public propertyStatus
Gets or sets the status

List of authorized values in GiftVoucherStatus

Public propertyStatusMember
Gets the status

List of authorized values in GiftVoucherStatus

Public propertyUniqueId
Gets or sets the unique Id
(Inherited from ISynchronizableEntityBase.)
Public propertyUniqueIdMember
Gets the unique Id
(Inherited from ISynchronizableEntityBase.)
Top
Methods
  NameDescription
Public methodAppend
Method for add a new entity to the media. Update the entity to its default value.
(Inherited from IEntity.)
Public methodCancel
Cancel the edit mode without saving, and reload the entity
(Inherited from IEntity.)
Public methodCancelEdit
Cancel the edit mode without saving, without reload the entity
(Inherited from IEntity.)
Public methodCheckData
Check the data of the entity
(Inherited from IEntity.)
Public methodClear
Clear the entity content and reinitialize it to the default value
(Inherited from IEntity.)
Public methodClone
Clone an entity
(Inherited from IEntity.)
Public methodCopyTo(IEntity)
Copy the entity content to another entity
(Inherited from IEntity.)
Public methodCopyTo(IEntity, Boolean)
Copy the entity content to another entity
(Inherited from IEntity.)
Public methodDelete
Method for delete a existing entity from the media
(Inherited from IEntity.)
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodEdit
Method to pass in edit mode a existing entity in the media (for exemple, add a lock for database)
(Inherited from IEntity.)
Public methodGetExtension
Gets the extension.
(Inherited from IApiEntity.)
Public methodLoad
Method for loading the entity
(Inherited from IEntity.)
Public methodSave
Method for saving the entity to the media
(Inherited from IEntity.)
Public methodSetComplexMemberReadOnly
Set the read only property to a member
(Inherited from IEntity.)
Public methodShowMessage
Method to display a message. The message is displayed if the UI has connected to the ShowMessage event
(Inherited from IApiEntity.)
Top
Events
  NameDescription
Public eventModeChanged
Event raised on mode changed
(Inherited from IEntity.)
Top
See Also