DocumentAmount Class

Contains a specific instance of an additional amount for a specific document. Entity: Gen_Document_Amounts

Inheritance Hierarchy

SystemObject
  Aloe.SystemFrameworks.DomainDomainObject
    Aloe.SystemFrameworks.DomainEditableDomainObject
      Aloe.SystemFrameworks.DomainEntityObject
        Aloe.EnterpriseOne.Model.CoreEnterpriseOneEntityObject
          Aloe.EnterpriseOne.Model.GeneralDocumentAmount

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

Syntax

C++

Copy

public class DocumentAmount : EnterpriseOneEntityObject, 
	IDocumentDetail, IDocumentComponent

Public Class DocumentAmount
	Inherits EnterpriseOneEntityObject
	Implements IDocumentDetail, IDocumentComponent

public ref class DocumentAmount : public EnterpriseOneEntityObject, 
	IDocumentDetail, IDocumentComponent

type DocumentAmount =  
    class
        inherit EnterpriseOneEntityObject
        interface IDocumentDetail
        interface IDocumentComponent
    end

The DocumentAmount type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	BaseAmount	The calculated base amount (in documents currency) from the last document amount recalculation. The base amount is the base, over which the additional amounts are calculated. Null if the amount is not distributed yet. [Currency: LogisticsDocument.DocumentCurrency] [ReadOnly]
	ChangingAttributes	Gets the attributes that are currently changing. Can be used in attribute change event handler to prevent stack overflow. (Inherited from EditableDomainObject.)
	CustomProperties	Gets the custom properties of the object. (Inherited from EnterpriseOneEntityObject.)
	Document	The Document to which this DocumentAmount belongs. [Required] [Filter(multi eq)] [Owner]
	DocumentAmountType	The type of the amount. [Required] [Filter(multi eq)]
	ExtendedProperties	Extended properties contain temporary (not persisted) values in the object instance. (Inherited from EntityObject.)
	Id	The unique Id of the entity object (Inherited from EntityObject.)
	InputAmount	When not null, specifies directly the amount of the additional amount. [Currency: GetInputAmountCurrency()] [Filter(ge;le)]
	InputAmountCurrency	When specifying the amount directly in Input Amount, this contains the currency of the amount. Used and required when Input Amount is not null. [Filter(multi eq)]
	InputPercent	When not null, specifies that the amount for this document will be calculated as percent of the base amounts (which are defined in the amount type). [Filter(ge;le)]
	InputUnit	Measurement unit of the input unit amount. [Filter(multi eq)]
	InputUnitAmount	Input unit amount for the calculation of the current amount. [Currency: GetInputAmountCurrency()] [Filter(eq;ge;le)]
	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.)
	LogisticsDocument	Gets the owner logistic document.
	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.)
	ObjectState	Gets the state of the domain object. (Overrides EditableDomainObjectObjectState.)
	ReferencedDocuments	List of DocumentAmountReferencedDocument child objects, based on the General.DocumentAmountReferencedDocument.DocumentAmount back reference
	ReferencedLogisticsDocuments	Gets the referenced logistics documents. If ReferencedDocuments is empty, the owner document is returned.
	Repository	Provides access to DocumentAmountsRepository repository methods
	TotalDistributedAmount	The total amount (in documents currency) which was distributed to the documents lines. Null if the amount is not distributed yet. [Currency: LogisticsDocument.DocumentCurrency] [ReadOnly]
	Transaction	The EnterpriseOne transaction to which this object is attached. (Inherited from EnterpriseOneEntityObject.)
	UserCanChangeInput	True if the user, entering the document is allowed to change the default input percent. [Required] [Default(true)]

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.)
	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.)
	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.)
	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.General Namespace