IPutAwayStockDocumentLineEntity Interface

PutAway StockDocument Line Entity

(Lignes de documents de stock)

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

Syntax

Copy

[GuidAttribute("0EE3FD28-5395-4e59-A3FD-F3EAC4EB7AD8")]
public interface IPutAwayStockDocumentLineEntity : IStockDocumentLineEntityBase, 
	IDocumentLineEntityBase, IEntity<IDocumentLineEntityBase>, IEntityItemBase, IEntity, 
	IApiEntity, IDisposable, IEquatable<IProxy>

<GuidAttribute("0EE3FD28-5395-4e59-A3FD-F3EAC4EB7AD8")>
Public Interface IPutAwayStockDocumentLineEntity
	Inherits IStockDocumentLineEntityBase, IDocumentLineEntityBase, IEntity(Of IDocumentLineEntityBase), 
	IEntityItemBase, IEntity, IApiEntity, IDisposable, IEquatable(Of IProxy)

The IPutAwayStockDocumentLineEntity type exposes the following members.

Properties

	Name	Description
	AllowComponentsModification	Gets or sets whether the component modifications are allowed (Inherited from IDocumentLineEntityBase.)
	AllowComponentsModificationMember	Gets whether the component modifications are allowed (Inherited from IDocumentLineEntityBase.)
	AllowedItemType	Gets the allowed item types (Inherited from IDocumentLineEntityBase.)
	BillOfQuantitiesArguments	Gets the bill of quantities arguments. (Inherited from IDocumentLineEntityBase.)
	BillOfQuantitiesProgram	Gets the bill of quantities program. (Inherited from IDocumentLineEntityBase.)
	Children	collection of children entity. The collection is hierarchical, so an entity item has its own children (Inherited from IEntityT.)
	CreatedDate	Gets the Created Date (Inherited from IEntity.)
	CreatedUser	Gets the Created User (Inherited from IEntity.)
	DealId	Gets or sets the deal id (Inherited from IDocumentLineEntityBase.)
	DealIdMember	Gets the deal id (Inherited from IDocumentLineEntityBase.)
	Description	Gets or sets the description (Description (facturation)) (Inherited from IDocumentLineEntityBase.)
	DescriptionClear	Gets or sets the description without RTF formatting (Inherited from IDocumentLineEntityBase.)
	DescriptionClearMember	Gets the description without RTF formatting (Inherited from IDocumentLineEntityBase.)
	DescriptionMember	Gets the description (Description (facturation)) (Inherited from IDocumentLineEntityBase.)
	DispatchedTrackingQuantity	Gets or sets the dispatched tracking quantity (used during dispatch) (Inherited from IDocumentLineEntityBase.)
	DispatchedTrackingQuantityMember	Get the dispatched tracking quantity (used during dispatch) (Inherited from IDocumentLineEntityBase.)
	DocumentEntity	return the OwnerEntity casted in DocumentEntityBase (Inherited from IDocumentLineEntityBase.)
	DocumentId	Gets or sets the document Id (Inherited from IDocumentLineEntityBase.)
	DocumentIdMember	Gets the document Id (Inherited from IDocumentLineEntityBase.)
	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.)
	ExecutionQuoteLineDescription	Gets or sets the execution quote line description. (Inherited from IStockDocumentLineEntityBase.)
	ExecutionQuoteLineDescriptionMember	Gets the execution quote line description. (Inherited from IStockDocumentLineEntityBase.)
	ExecutionQuoteLineId	Gets or sets the execution quote line identifier. (Inherited from IStockDocumentLineEntityBase.)
	ExecutionQuoteLineIdMember	Gets the execution quote line identifier. (Inherited from IStockDocumentLineEntityBase.)
	ExecutionQuoteLineNumbering	Gets or sets the execution quote line numbering. (Inherited from IStockDocumentLineEntityBase.)
	ExecutionQuoteLineNumberingMember	Gets the execution quote line numbering. (Inherited from IStockDocumentLineEntityBase.)
	Id	Id which is PK auto increment (Inherited from IDocumentLineEntityBase.)
	IdMember	Id which is PK auto increment (Inherited from IDocumentLineEntityBase.)
	IncidentId	Gets or sets the incident Id (Inherited from IDocumentLineEntityBase.)
	IncidentIdMember	Gets the incident Id (Inherited from IDocumentLineEntityBase.)
	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.)
	IsPrintable	Gets or sets whether the line detail is printable List of authorized values in DocumentLinePrintableType (Inherited from IDocumentLineEntityBase.)
	IsPrintableMember	Gets whether the line detail is printable List of authorized values in DocumentLinePrintableType (Inherited from IDocumentLineEntityBase.)
	IsReferencedItem	Gets or sets whether the item is referenced (Inherited from IDocumentLineEntityBase.)
	IsReferencedItemMember	Gets whether the item is referenced (Inherited from IDocumentLineEntityBase.)
	ItemAllowNegatifStock	Gets or sets whether the negative stock is allowed for the item (Inherited from IDocumentLineEntityBase.)
	ItemAllowNegatifStockMember	Gets whether the negative stock is allowed for the item (Inherited from IDocumentLineEntityBase.)
	ItemBarCode	Gets or sets the item bar code (Inherited from IStockDocumentLineEntityBase.)
	ItemBarCodeMember	Gets the item bar code (Inherited from IStockDocumentLineEntityBase.)
	ItemCaption	Gets or sets the item caption (Inherited from IDocumentLineEntityBase.)
	ItemCaptionMember	Gets the item caption (Inherited from IDocumentLineEntityBase.)
	ItemCostPrice	Gets the item cost price (Prix de revient)
	ItemCostPriceMember	Gets the item cost price (Prix de revient)
	ItemDefaultAllowedStorehouseId	Gets or sets the item default allowed storehouse id (Inherited from IDocumentLineEntityBase.)
	ItemDefaultAllowedStorehouseIdMember	Gets the item default allowed storehouse id (Inherited from IDocumentLineEntityBase.)
	ItemFamilyId	Gets or sets the item family Id (Inherited from IDocumentLineEntityBase.)
	ItemFamilyIdMember	Gets the item family Id (Inherited from IDocumentLineEntityBase.)
	ItemHasBeenReloaded	Gets or sets whether the item has been reloaded (Inherited from IDocumentLineEntityBase.)
	ItemHasBeenReloadedMember	Gets whether the item has been reloaded (Inherited from IDocumentLineEntityBase.)
	ItemId	Gets or sets the item Id (Inherited from IDocumentLineEntityBase.)
	ItemIdMember	Gets the item Id (Inherited from IDocumentLineEntityBase.)
	ItemIsTracked	Gets wether related item is tracked by serial or batch number (Inherited from IDocumentLineEntityBase.)
	ItemPurchasePriceUpdateType	saleDocumentLineEntity Gets the ItemPurchasePriceUpdateType List of authorized values in PurchasePriceUpdateTypes (Inherited from IStockDocumentLineEntityBase.)
	ItemPurchasePriceUpdateTypeMember	saleDocumentLineEntity Gets the ItemPurchasePriceUpdateType List of authorized values in PurchasePriceUpdateTypes (Inherited from IStockDocumentLineEntityBase.)
	ItemSubFamilyId	Gets or sets the item family Id (Inherited from IDocumentLineEntityBase.)
	ItemSubFamilyIdMember	Gets the item family Id (Inherited from IDocumentLineEntityBase.)
	ItemUnitConversionRate	Gets or sets the item unit conversion rate (Inherited from IDocumentLineEntityBase.)
	ItemUnitConversionRateMember	Gets the item unit conversion rate (Inherited from IDocumentLineEntityBase.)
	ItemUnitType	Gets or sets the item unit type (Inherited from IDocumentLineEntityBase.)
	ItemUnitTypeMember	Gets the item unit type (Inherited from IDocumentLineEntityBase.)
	ItemValue	Gets or sets the item value (Valeur de l'article)
	ItemValueMember	Gets the item value (Valeur de l'article)
	LimitDate	Gets or sets the item limit date (Inherited from IDocumentLineEntityBase.)
	LimitDateAllowed	Gets whether limit date allowed. Allow to retrieve limit date by code for known tracking number Do not allow user to enter a limit date (Inherited from IDocumentLineEntityBase.)
	LimitDateMember	Gets the item limit date (Inherited from IDocumentLineEntityBase.)
	LimitDateRequired	Gets whether item limit date is required (Inherited from IDocumentLineEntityBase.)
	LimitDateSafetyDelay	Gets or sets the safety delay for limit date (Inherited from IDocumentLineEntityBase.)
	LimitDateSafetyDelayMember	Gets the safety delay for limit date (Inherited from IDocumentLineEntityBase.)
	LimitDateSafetyDelayMode	Gets or sets the safety delay mode (before or after) List of authorized values in LimitDateSafetyDelayModeTypes (Inherited from IDocumentLineEntityBase.)
	LimitDateSafetyDelayModeMember	Gets the safety delay mode (before or after) List of authorized values in LimitDateSafetyDelayModeTypes (Inherited from IDocumentLineEntityBase.)
	LineOrder	Gets or sets the line Number (Inherited from IDocumentLineEntityBase.)
	LineOrderMember	Gets the line Number (Inherited from IDocumentLineEntityBase.)
	LineType	Gets or sets the type line List of authorized values in DocumentLineType (Inherited from IDocumentLineEntityBase.)
	LineTypeMember	Gets the type line List of authorized values in DocumentLineType (Inherited from IDocumentLineEntityBase.)
	Location	Gets the location. (Inherited from IDocumentLineEntityBase.)
	MaintenanceContractId	Gets or sets the maintenance contract Id (Inherited from IDocumentLineEntityBase.)
	MaintenanceContractIdMember	Gets the maintenance contract Id (Inherited from IDocumentLineEntityBase.)
	ManageStock	Indicate if this line generate stock movement (Inherited from IDocumentLineEntityBase.)
	ManageStockMember	Indicate if this line generate stock movement (Inherited from IDocumentLineEntityBase.)
	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.)
	NomenclatureLevel	Gets or sets the Nomenclature Level (Inherited from IDocumentLineEntityBase.)
	NomenclatureLevelMember	Get the Nomenclature Level (Inherited from IDocumentLineEntityBase.)
	OwnerEntity	Gets the main entity that own all this items/collection (Inherited from IEntity.)
	Parent	Parent entity collection, that own this item (Inherited from IEntityT.)
	ParentEntity	The entity item is in collection, this collection can be the children collection of an other entity (because the hierarchical possibility), returns this entity. Correspond to Parent.Parent (Inherited from IEntityT.)
	ParentLineId	Gets or sets the parent line ID (Inherited from IDocumentLineEntityBase.)
	ParentLineIdMember	Gets the parent line ID (Inherited from IDocumentLineEntityBase.)
	PhaseLevel	Gets or sets the phase level (Inherited from IDocumentLineEntityBase.)
	PhaseLevelMember	Gets the phase level (Inherited from IDocumentLineEntityBase.)
	PricesDecimalNumber	Gets/set the prices decimal number (Inherited from IDocumentLineEntityBase.)
	PricesDecimalNumberMember	Gets/set the prices decimal number (Inherited from IDocumentLineEntityBase.)
	PrintComponentsDetail	Gets or set the print components detail value from item (not saved in database) List of authorized values in DocumentLinePrintableType (Inherited from IDocumentLineEntityBase.)
	PrintComponentsDetailMember	Gets or set the print components detail value from item (not saved in database) List of authorized values in DocumentLinePrintableType (Inherited from IDocumentLineEntityBase.)
	ProgressDocumentLineId	Gets or sets the progress document line identifier. (Inherited from IStockDocumentLineEntityBase.)
	ProgressDocumentLineIdMember	Gets the progress document line identifier. (Inherited from IStockDocumentLineEntityBase.)
	Quantity	Gets or sets the quantity (Inherited from IDocumentLineEntityBase.)
	QuantityDecimalNumber	QuantityDecimalNumber which is changed when unitId change (Inherited from IDocumentLineEntityBase.)
	QuantityDecimalNumberMember	QuantityDecimalNumber which is changed when unitId change (Inherited from IDocumentLineEntityBase.)
	QuantityMember	Gets the quantity (Inherited from IDocumentLineEntityBase.)
	RangeItemId	Gets or sets the range item identifier. (Inherited from IDocumentLineEntityBase.)
	RangeItemIdMember	Gets the range item identifier. (Inherited from IDocumentLineEntityBase.)
	RangeTypeCombinationCaption	Gets the range type combination caption (Inherited from IDocumentLineEntityBase.)
	ReadOnly	Gets/Sets if the entity is in read only mode, to preserve from data changing (Inherited from IEntity.)
	RealQuantity	Gets or sets the real quantity function of the parent (Inherited from IDocumentLineEntityBase.)
	RealQuantityMember	Gets the real quantity function of the parent (Inherited from IDocumentLineEntityBase.)
	RelatedItemActiveState	Gets or sets the related item active state List of authorized values in ItemActiveState (Inherited from IDocumentLineEntityBase.)
	RelatedItemActiveStateMember	Get the related item active state List of authorized values in ItemActiveState (Inherited from IDocumentLineEntityBase.)
	ReplacementItem	Gets or sets the replacement Item (Inherited from IDocumentLineEntityBase.)
	ReplacementItemCaption	Gets or sets the replacement item caption (Inherited from IDocumentLineEntityBase.)
	ReplacementItemCaptionMember	Gets the replacement item caption (Inherited from IDocumentLineEntityBase.)
	ReplacementItemMember	Gets the replacement Item (Inherited from IDocumentLineEntityBase.)
	ReplacementItemUnitCaption	Gets or sets the ReplacementItemUnitCaption (Inherited from IDocumentLineEntityBase.)
	ReplacementItemUnitCaptionMember	Gets the ReplacementItemUnitCaption (Inherited from IDocumentLineEntityBase.)
	ReplacementItemUnitConversionRate	Gets or sets the ReplacementItemUnitConversionRate (Inherited from IDocumentLineEntityBase.)
	ReplacementItemUnitConversionRateMember	Gets the ReplacementItemUnitConversionRate (Inherited from IDocumentLineEntityBase.)
	ReplacementItemUnitId	Gets or sets the ReplacementItemUnitId (Inherited from IDocumentLineEntityBase.)
	ReplacementItemUnitIdMember	Gets the ReplacementItemUnitId (Inherited from IDocumentLineEntityBase.)
	ReplacementItemUnitType	Gets or sets the ReplacementItemUnitType (Inherited from IDocumentLineEntityBase.)
	ReplacementItemUnitTypeMember	Gets the ReplacementItemUnitType (Inherited from IDocumentLineEntityBase.)
	Silent	Get/Sets if the entity is in silent mode (Inherited from IEntity.)
	States	Gets the entity states (Inherited from IEntity.)
	StockMovementId	Gets or sets the stock movement Id (Inherited from IDocumentLineEntityBase.)
	StockMovementIdMember	Gets the stock movement Id (Inherited from IDocumentLineEntityBase.)
	StorehouseCaption	Gets or sets the line storehouse caption (Inherited from IDocumentLineEntityBase.)
	StorehouseCaptionMember	Get the line storehouse caption (Inherited from IDocumentLineEntityBase.)
	StorehouseId	Gets or sets the storehouse Id (Inherited from IDocumentLineEntityBase.)
	StorehouseIdMember	Gets the storehouse Id (Inherited from IDocumentLineEntityBase.)
	StorehouseRequired	Get whether Storehouse is required (Inherited from IDocumentLineEntityBase.)
	TechnicalDescription	Gets or sets the technical description (Inherited from IDocumentLineEntityBase.)
	TechnicalDescriptionClear	Gets or sets the technical description without RTF formatting (Inherited from IDocumentLineEntityBase.)
	TechnicalDescriptionClearMember	Gets the technical description without RTF formatting (Inherited from IDocumentLineEntityBase.)
	TechnicalDescriptionMember	Gets the technical description (Inherited from IDocumentLineEntityBase.)
	TopParentLineId	Gets or sets the base parent line Id (top entity in hierarchical entities) (Inherited from IDocumentLineEntityBase.)
	TopParentLineIdMember	Gets the base parent line Id (top entity in hierarchical entities) (Inherited from IDocumentLineEntityBase.)
	TotalValue	Gets or sets the total value (Valeur totale)
	TotalValueMember	Gets the total value (Valeur totale)
	TotalVolume	Gets or sets total volume in reference unit (m3) (Inherited from IDocumentLineEntityBase.)
	TotalVolumeMember	Gets total volume in reference unit (m3) (Inherited from IDocumentLineEntityBase.)
	TotalWeight	Gets or sets total weight in reference unit (Kg) (Inherited from IDocumentLineEntityBase.)
	TotalWeightMember	Gets total weight in reference unit (Kg) (Inherited from IDocumentLineEntityBase.)
	TrackingDispatch	Gets line Tracking dispatch (Inherited from IDocumentLineEntityBase.)
	TrackingNumber	Gets or sets the tracking number (Inherited from IDocumentLineEntityBase.)
	TrackingNumberAllowed	Gets whether tracking number allowed (Inherited from IDocumentLineEntityBase.)
	TrackingNumberInputMode	Get the tracking number input mode for the line (Inherited from IDocumentLineEntityBase.)
	TrackingNumberMember	Get the tracking number (Inherited from IDocumentLineEntityBase.)
	TrackingNumberRequired	Get whether Item Tracking Number is required (Inherited from IDocumentLineEntityBase.)
	UnitCaptionInUserLanguage	Gets or sets the Unit caption in user language (Inherited from IDocumentLineEntityBase.)
	UnitCaptionInUserLanguageMember	Gets the Unit caption in user language (Inherited from IDocumentLineEntityBase.)
	UnitDecimalNumber	Gets or sets the unit decimal number (Inherited from IDocumentLineEntityBase.)
	UnitDecimalNumberMember	Gets the unit decimal number (Inherited from IDocumentLineEntityBase.)
	UnitId	Gets or sets the unit Id (Inherited from IDocumentLineEntityBase.)
	UnitIdMember	Gets the unit Id (Inherited from IDocumentLineEntityBase.)
	UseReplacementItem	Gets or sets whether the replacement item must be used (Inherited from IDocumentLineEntityBase.)
	UseReplacementItemMember	Get whether the replacement item must be used (Inherited from IDocumentLineEntityBase.)
	VirtualMovementDateValue	Gets the planned virtual movement date (Inherited from IDocumentLineEntityBase.)
	Volume	Gets or sets the item volume (Inherited from IDocumentLineEntityBase.)
	VolumeMember	Gets the item volume (Inherited from IDocumentLineEntityBase.)
	VolumeUnitDecimalNumber	Gets or sets the volume unit decimal number (Inherited from IDocumentLineEntityBase.)
	VolumeUnitDecimalNumberMember	Gets the volume unit decimal number (Inherited from IDocumentLineEntityBase.)
	VolumeUnitId	Gets or sets the volume unit Id (Inherited from IDocumentLineEntityBase.)
	VolumeUnitIdConversionRate	Gets or sets the volume unit conversion rate (Inherited from IDocumentLineEntityBase.)
	VolumeUnitIdConversionRateMember	Gets the volume unit conversion rate (Inherited from IDocumentLineEntityBase.)
	VolumeUnitIdMember	Gets the volume unit Id (Inherited from IDocumentLineEntityBase.)
	Weight	Gets or sets the item weight (Inherited from IDocumentLineEntityBase.)
	WeightMember	Gets the item weight (Inherited from IDocumentLineEntityBase.)
	WeightUnitConversionRate	Gets or sets the unit weight conversion rate (Inherited from IDocumentLineEntityBase.)
	WeightUnitConversionRateMember	Gets the unit weight conversion rate (Inherited from IDocumentLineEntityBase.)
	WeightUnitDecimalNumber	Gets or sets the weight unit decimal number (Inherited from IDocumentLineEntityBase.)
	WeightUnitDecimalNumberMember	Gets the weight unit decimal number (Inherited from IDocumentLineEntityBase.)
	WeightUnitId	Gets or sets the wright unit Id (Inherited from IDocumentLineEntityBase.)
	WeightUnitIdMember	Gets the wright unit Id (Inherited from IDocumentLineEntityBase.)

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.)
	CheckIfParentIsNomenclature	Check if parent entity is a nomenclature (commercial or fabrication) (Inherited from IDocumentLineEntityBase.)
	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.)
	GetHasTrackingDispatch	Gets whether the line has tracking dispatch. (Inherited from IDocumentLineEntityBase.)
	HasTrackingNumberComponent	check if line item has component tracked by serial number (Inherited from IDocumentLineEntityBase.)
	Load	Method for loading the entity (Inherited from IEntity.)
	RecalculateNomenclatureVolume	Recalculate nomenclature unit volume from components (Inherited from IDocumentLineEntityBase.)
	RecalculateNomenclatureWeight	Recalculate nomenclature unit weight from components (Inherited from IDocumentLineEntityBase.)
	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 IPutAwayStockDocumentLineEntity type can be instantiated with EBP.Api.Utils<TExtension>.GetInterface<T>

Copy

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

Reference

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