ShipmentOrderLine Class

Represents detail lines of orders for shipment of sales orders to customers. Each line orders the shipment of one product. Entity: Log_Shipment_Order_Lines

Inheritance Hierarchy

SystemObject
  Aloe.SystemFrameworks.DomainDomainObject
    Aloe.SystemFrameworks.DomainEditableDomainObject
      Aloe.SystemFrameworks.DomainEntityObject
        Aloe.EnterpriseOne.Model.CoreEnterpriseOneEntityObject
          Aloe.EnterpriseOne.Model.GeneralDocumentChild
            Aloe.EnterpriseOne.Model.GeneralDocumentLine
              Aloe.EnterpriseOne.Model.GeneralLogisticsDocumentLine
                Aloe.EnterpriseOne.Model.Logistics.ShipmentShipmentOrderLine

Namespace: Aloe.EnterpriseOne.Model.Logistics.Shipment
Assembly: Aloe.EnterpriseOne.Model (in Aloe.EnterpriseOne.Model.dll) Version: 20.1.3.5

Syntax

C++

Copy

public class ShipmentOrderLine : LogisticsDocumentLine

Public Class ShipmentOrderLine
	Inherits LogisticsDocumentLine

public ref class ShipmentOrderLine : public LogisticsDocumentLine

type ShipmentOrderLine =  
    class
        inherit LogisticsDocumentLine
    end

The ShipmentOrderLine type exposes the following members.

Constructors

	Name	Description
	ShipmentOrderLine	Initializes a new instance of the ShipmentOrderLine class with specific ObjectTransaction

Top

Properties

	Name	Description
	BoxCount	The count of boxes in which the goods are packaged. null means unknown.
	ChangingAttributes	Gets the attributes that are currently changing. Can be used in attribute change event handler to prevent stack overflow. (Inherited from EditableDomainObject.)
	ConfirmedQuantity	Gets or sets the confirmed quantity. Can be null. Inheritors that do not support confirmed quantity always return null. (Inherited from LogisticsDocumentLine.)
	ConfirmedQuantityBase	Gets or sets the confirmed quantity base. Can be null. Inheritors that do not support confirmed quantity always return null. (Inherited from LogisticsDocumentLine.)
	ConfirmedStandardQuantityBase	Gets or sets the confirmed standard quantity base. Can be null. Inheritors that do not support confirmed quantity always return null. (Inherited from LogisticsDocumentLine.)
	CustomProperties	Gets the custom properties of the object. (Inherited from EnterpriseOneEntityObject.)
	Document	The ShipmentOrder to which this ShipmentOrderLine belongs. [Required] [Filter(multi eq)] (Overrides DocumentChildDocument.)
	ExtendedProperties	Extended properties contain temporary (not persisted) values in the object instance. (Inherited from EntityObject.)
	Finished	True if this shipment should prohibit further shipments for the sales order line. [Required] [Default(false)] [Filter(eq)]
	GrossWeightkg	The gross weight of the whole line in kilogramms. null means unknown.
	GuaranteePeriodDays	Guarantee period in days for the offered product. null for non-serviced products.
	Heightm	The height of the package in meters. null means unknown.
	Id	The unique Id of the entity object (Inherited from EntityObject.)
	IsGhost	Returns true when the object is a ghost object (Inherited from EntityObject.)
	IsLoaded	Gets a value indicating whether the associated data for this domain object is loaded. (Overrides EntityObjectIsLoaded.)
	ItemString	Gets or sets the value of a data attribute (Inherited from DomainObject.)
	ItemIDataAttribute	Gets or sets the value of a data attribute (Inherited from DomainObject.)
	Lengthm	The length of the package in meters. null means unknown.
	LineAmount	Gets or sets the line amount. (Inherited from LogisticsDocumentLine.)
	LineNo	Line number, unique for the shipment. [Required]
	LineNumber	Line number, unique for the shipment. [Required] (Overrides DocumentLineLineNumber.)
	LineStore	Gets or sets the line store. Some logistics lines does not support line store and this property will alwais return null/ghost object. (Inherited from LogisticsDocumentLine.)
	LogisticDocument	Gets the logistics document of the line. (Inherited from LogisticsDocumentLine.)
	Lot	The store lot from which to take the goods. [Filter(multi eq)] (Overrides LogisticsDocumentLineLot.)
	NetWeightkg	The net weight of the entire batch of goods in kilograms. null means unknown.
	NoEvents	Turns on "No events" mode and returns a class, that will turn it off when Disposed. See remarks for more info. (Inherited from DomainObject.)
	Notes	Specific notes for this line.
	ObjectState	Gets the state of the domain object. (Overrides EditableDomainObjectObjectState.)
	PalletNo	The number of the pallet in which the goods are packaged. null means unknown.
	ParentDocument	The document, which the current line executes. null when the current line does not execute another line. [Filter(multi eq)]
	ParentLineNo	The number of the line within the parent document, which the current line executes. null when the current line does not execute parent line.
	ParentSalesOrderLine	Sales order line which is shipped. [Required] [Filter(multi eq)]
	PersistLot	If checked specifies that the lot in the line cannot be changed in the sub-documents created by the current document. [Required] [Default(false)] [Filter(eq)]
	Product	Gets or sets the product. (Overrides LogisticsDocumentLineProduct.)
	ProductVariant	Gets or sets the product variant. Some logistics lines does not support product variants and this property will alwais return null/ghost object. (Inherited from LogisticsDocumentLine.)
	Quantity	The quantity to be shipped. [Unit: QuantityUnit] [Required] [Default(1)] (Overrides LogisticsDocumentLineQuantity.)
	QuantityBase	The equivalence of Quantity in the base measurement category of the product. [Unit: ParentSalesOrderLine.Product.BaseMeasurementCategory.BaseUnit] [Required] (Overrides LogisticsDocumentLineQuantityBase.)
	QuantityUnit	The measurement unit of Quantity. [Required] [Filter(multi eq)] (Overrides LogisticsDocumentLineQuantityUnit.)
	Repository	Provides access to ShipmentOrderLinesRepository repository methods
	SerialNumber	The serial number of the shipped product. null means that serial number is unknown or not applicable. [Filter(multi eq)] (Overrides LogisticsDocumentLineSerialNumber.)
	ShipmentOrder	The ShipmentOrder to which this ShipmentOrderLine belongs. [Required] [Filter(multi eq)] [Owner]
	StandardQuantityBase	The theoretical quantity in base measurement unit according to the current measurement dimensions for the product. Used to measure the execution. [Unit: ParentSalesOrderLine.Product.BaseMeasurementCategory.BaseUnit] [Required] [ReadOnly] (Overrides LogisticsDocumentLineStandardQuantityBase.)
	StoreBin	The store bin from which to take the goods. [Filter(multi eq)] (Overrides LogisticsDocumentLineStoreBin.)
	SupportsConfirmedQuantity	Gets a value indicating whether the line supports confirmed quantity. (Inherited from LogisticsDocumentLine.)
	SupportsLineAmount	Gets a value indicating whether the line supports line amount. (Inherited from LogisticsDocumentLine.)
	SupportsUnitAmount	Gets a value indicating whether the line supports unit amount. (Inherited from LogisticsDocumentLine.)
	Transaction	The EnterpriseOne transaction to which this object is attached. (Inherited from EnterpriseOneEntityObject.)
	UnitAmount	Gets or sets the unit amount of the logistics line. This can be unit price or unit cost. (Inherited from LogisticsDocumentLine.)
	Volumel	The volume in litres of the whole batch. null means unknown.
	Widthm	The width of the package in meters. null means unknown.

Top

Methods

	Name	Description
	Delete	Deletes the domain object. (Overrides EntityObjectDelete.)
	DuplicateObject	Creates a copy of the object. (Inherited from EntityObject.)
	Equals(Object)	Determines whether the specified Object, is equal to this instance. (Inherited from EntityObject.)
	Equals(EntityObject)	Indicates whether the current object is equal to another object of the same type. (Inherited from EntityObject.)
	ExecuteBusinessRules	Executes all business rules for the object for the specified BusinessEvent. The validation fails are saved in the event. (Inherited from EditableDomainObject.)
	FindMatchingLine	Searches through a child collection for a line, matching the current line. Returns null if no matching line is found. (Inherited from DocumentLine.)
	GetAggregateParent	Gets the aggregate parent of this entity object. If this is the aggregate root the return value is null. (Inherited from EntityObject.)
	GetAggregateRoot	Gets the aggregate root entity object. If the entity does not have aggregate parent reference aggregate root is this entity object. (Inherited from EntityObject.)
	GetChangedAttributes	Gets the changed attributes for a given DataAttributeChangeEventArgs. Used for front-end generic business rules to recalculate the state of the object according to attribute change events. (Overrides LogisticsDocumentLineGetChangedAttributes(DataAttributeChangeEventArgs).)
	GetDistributedAmounts	Gets the distributed amount among this line by specified DocumentAmountType. Only distributed amounts from the line's document are returned. (Inherited from LogisticsDocumentLine.)
	GetHashCode	Returns a hash code for this instance. (Inherited from EntityObject.)
	GetRelatedObjectsForValidation	Gets the related objects which would need validation upon validation of this object. (Inherited from EntityObject.)
	GetUnshippedQuantity	Gets the remaining unshipped quantity from the Shipment Order Line Quantity. The Quantity returned is in the measurement unit of the Parent Sales order line.
	IssueWarning(String)	Issues a warning with the specified message. (Inherited from EditableDomainObject.)
	IssueWarning(ExpressionFuncString, Object)	Issues a warning with the specified message. The message can contain standard string placeholders. (Inherited from EditableDomainObject.)
	MatchesFilter(DataAccessFilter)	Returns true if this entity object matches the specified filter. (Inherited from EnterpriseOneEntityObject.)
	MatchesFilter(DataAccessFilter, IBufferRow)	Matches the filter against the specified row and returns the result of the match. (Inherited from EnterpriseOneEntityObject.)
	Refresh	Refreshes this instance with data from data source. Only objects with ObjectState equal to Unchanged are refreshed. (Inherited from EntityObject.)
	ToString	Returns a String that represents this instance. (Inherited from EntityObject.)
	ToString(String)	Returns a String that represents this instance. (Inherited from EntityObject.)
	TryGet	Tries to get the specified attribute and returns it or null, when it is not found. (Inherited from DomainObject.)

Top

Extension Methods

	Name	Description
	FillAggregateMissingDefaults	Recalculates the default values for all objects in the aggregate. (Defined by EntityObjectExtensions.)
	FillMissingDefaults	Executes the late default expression defined in each attribute (if any) if the current value is null or equal to a constant default. (Defined by EntityObjectExtensions.)
	FormatString	Converts the object to string based on the format specified. (Defined by FormatStringExtensions.)
	GetExtensibleDataObject	Gets the extensible data object related to the entity object. Can return null if such ExtensibleDataObject doesn't exist. (Defined by ExtensibleDataObjectExtensions.)
	GetOrCreateExtensibleDataObject	Returns an ExtensibleDataObject related to the entity object. If such object doesn't exist the object is created in the same transaction. (Defined by ExtensibleDataObjectExtensions.)
	RecalculateMasterAttributes	Recalculates the values of a master attributes in a master-detail relationship. (Defined by EntityObjectExtensions.)
	RecalculateMissingValues	Recalculates the missing values using the first reactive expression of the attributes. (Defined by EntityObjectExtensions.)

Top

Reference

Aloe.EnterpriseOne.Model.Logistics.Shipment Namespace