Document Class

SystemObject
  Aloe.SystemFrameworks.DomainDomainObject
    Aloe.SystemFrameworks.DomainEditableDomainObject
      Aloe.SystemFrameworks.DomainEntityObject
        Aloe.EnterpriseOne.Model.CoreEnterpriseOneEntityObject
          Aloe.EnterpriseOne.Model.GeneralDocument
            More...

public abstract class Document : EnterpriseOneEntityObject, 
	IDocumentComponent

Public MustInherit Class Document
	Inherits EnterpriseOneEntityObject
	Implements IDocumentComponent

public ref class Document abstract : public EnterpriseOneEntityObject, 
	IDocumentComponent

[<AbstractClassAttribute>]
type Document =  
    class
        inherit EnterpriseOneEntityObject
        interface IDocumentComponent
    end

	Name	Description
	AccessKey	The access key, containing the user permissions for this document. null means that all users have unlimited permissions
	AdjustedDocument	The primary document, which the current document adjusts. null when this is not an adjustment document
	AdjustmentNumber	Consecutive number of the correction that this document is applying to the adjusted document. [Required]
	AdjustmentTime	Date/time when the document last has been adjusted by corrective document
	AdjustmentUser	The user who adjusted the document
	AssignedToUser	The user to which this document is assigned for handling. null means that the document is not assigned to specific user
	ChangingAttributes	Gets the attributes that are currently changing. Can be used in attribute change event handler to prevent stack overflow. (Inherited from EditableDomainObject.)
	Comments	List of DocumentComment child objects, based on the DocumentComment.Document back reference
	CompleteTime	Exact time, when the document was last completed[Filter(ge;le)]
	CreationTime	Date/Time when the document was created [Required][Filter(ge;le)]
	CreationUser	The login name of the user, who created the document [Required][Filter(like)]
	CurrencyDirectory	The currency directory, containing all the convertion rates, used by the document. null means that the document does not need currency convertions
	CustomProperties	Gets the custom properties of the object. (Inherited from EnterpriseOneEntityObject.)
	DistributedAmounts	List of DocumentDistributedAmount child objects, based on the DocumentDistributedAmount.Document back reference
	DocumentDate	The date on which the document was issued [Required][Filter(eq;ge;le)][ORD]
	DocumentId	Gets the Id of the document row, related to the domain object
	DocumentNo	Document number, unique within Document_Type_Id [Required][Filter(eq;like)][ORD]
	DocumentNotes	Notes for this Document
	DocumentText	Gets the document display text ({DocumentTypeName} {DocumentNo}).
	DocumentType	The user defined type of the document. Determines document behaviour, properties, additional amounts, validation, generations, etc. [Required]
	DocumentVersion	[Filter(eq;ge;le)]
	EnterpriseCompany	The enterprise company which issued the document [Required]
	EnterpriseCompanyLocation	The enterprise company location which issued the document. null means that there is only one location within the enterprise company and locations are not used
	EntityName	The entity name of the document equal to the entity name of the document type.[Filter(eq)] [ORD]
	ExtendedProperties	Extended properties contain temporary (not persisted) values in the object instance. (Inherited from EntityObject.)
	FileAttachments	List of DocumentFileAttachment child objects, based on the DocumentFileAttachment.Document back reference
	FromCompanyDivision	The division of the company, issuing the document. null when the document is not issued by any specific division
	FromParty	The party which issued the document [Required]
	Id	The unique Id of the entity object (Inherited from EntityObject.)
	IsAdjustingDocument	Gets a value indicating whether this instance is adjusting document.
	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.)
	LineAmounts	List of DocumentLineAmount child objects, based on the DocumentLineAmount.Document back reference
	MasterDocument	In a multi-document tree, this is the root document, that created the whole tree. If this is the root it is equal to Id [Required]
	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 object with regard to the transaction. (Overrides EditableDomainObjectObjectState.)
	Parent	In a multi-document tree, this is the direct parent document. If this is the root it is null
	ParentDocumentRelationshipType	Type of relationship between the current document and the parent document(s). Affects the constraints for execution/completion for the documents. Possible values: 'S' = 'Subtask', 'N' = 'Next task'.
	PlanningOnly	Indicates that the document is used only for planning (and as consequence its state cannot be greater than Planned) [Required]
	PrimeCauseDocument	The document that is the prime cause for creation of the current document
	Prints	List of DocumentPrint child objects, based on the DocumentPrint.Document back reference
	ReadOnly	True - the document is read only; false - the document is not read only [Required]
	ReferenceDate	The date to which this document refers, i.e. when the action really occurred. If null, Document_Date is taken [Filter(ge;le)]
	ReferenceDocumentNo	The number of the document (issued by the other party), which was the reason for the creation of the current document. The numebr should be unique within the party documents [Filter(eq;like)]
	ReleaseTime	Exact time, when the document was first released [Filter(ge;le)]
	Repository	The repository used to persist the entity object. (Inherited from EnterpriseOneEntityObject.)
	ResponsiblePerson	The person that is responsible for this order or transaction. It could be the sales person, the orderer, etc.
	ReverseOfDocument	The document which the current document is reverse of
	Sequence	The sequence that will be used to give new numbers to the documents of this type
	State	0=New;5=Corrective;10=Computer Planned;20=Human Planned;30=Released;40=Completed;50=Closed [Required][Filter(eq;ge;le)]
	StateChanges	List of DocumentStateChange child objects, based on the DocumentStateChange.Document back reference
	ToCompanyDivision	The division of the company, receiving the document. null when the document is not received by any specific division
	ToParty	The party which should receive the document
	Transaction	The EnterpriseOne transaction to which this object is attached. (Inherited from EnterpriseOneEntityObject.)
	UserStatus	The user status of this document if applicable for this document type. null means unknown or not yet set
	Versions	List of DocumentVersion child objects, based on the DocumentVersion.Document back reference
	Void	True if the document is null and void [Required][Filter(eq)]
	VoidReason	Reason for voiding the document, entered by the user
	VoidTime	Date/time when the document has become void
	VoidUser	The user who voided the document

Top

	Name	Description
	ChangeState	Changes the document state to the specified new state
	Complete	Changes the document state to Completed with all Release-ed sub-documents
	CreateAdjustmentDocument	Creates an adjustment document that doesn't adjust anything. Can be modified and saved.
	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.)
	GetAllParentDocuments	Gets all parent documents, traversing the parent document chain by using the Parent property.
	GetHashCode	Returns a hash code for this instance. (Inherited from EntityObject.)
	GetPrintout	Gets a document printout as a file. The returned value is Base64 string representation of the file contents.
	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.)
	MakeVoid	Makes the document void. The operation is irreversible.
	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.)
	Recalculate	The document and all of its owned objects will be altered to become valid.
	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

	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