DocumentType Class

List of user-defined document types. Each type has associated system entity (object class). Entity: Gen_Document_Types

Inheritance Hierarchy

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

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

Syntax

C++

Copy

public class DocumentType : EnterpriseOneEntityObject

Public Class DocumentType
	Inherits EnterpriseOneEntityObject

public ref class DocumentType : public EnterpriseOneEntityObject

type DocumentType =  
    class
        inherit EnterpriseOneEntityObject
    end

The DocumentType type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	AccessKey	The access key, containing the user permissions for this DocumentType. Null means that all users have unlimited permissions. [Filter(multi eq)]
	Amounts	List of DocumentTypeAmount child objects, based on the General.DocumentTypeAmount.DocumentType back reference
	ChangingAttributes	Gets the attributes that are currently changing. Can be used in attribute change event handler to prevent stack overflow. (Inherited from EditableDomainObject.)
	Code	Unique descriptive code of the document type. [Required] [Filter(eq)] [ORD]
	CreateManully	False if documents with this document type only can be generated; true - the user can create documents with this type. [Required] [Default(true)] [Filter(eq)]
	CustomProperties	Gets the custom properties of the object. (Inherited from EnterpriseOneEntityObject.)
	DefaultSalesOrderDocumentProperties	List of DefaultSalesOrderDocumentProperty child objects, based on the Crm.Sales.DefaultSalesOrderDocumentProperty.DocumentType back reference
	DefaultSalesOrderPaymentPlans	List of DefaultSalesOrderPaymentPlan child objects, based on the Crm.Sales.DefaultSalesOrderPaymentPlan.DocumentType back reference
	Description	The description of this DocumentType.
	DisallowOppositeValuesGeneration	Disallow the generation of decreasing scalar values (values with opposite directions than the original values determined by the parent document) through this document type. [Required] [Default(false)]
	DocumentTypeProperties	List of DocumentTypeProperty child objects, based on the General.DocumentTypeProperty.DocumentType back reference
	EnterpriseCompanies	List of DocumentTypeEnterpriseCompany child objects, based on the General.DocumentTypeEnterpriseCompany.DocumentType back reference
	EntityName	System entity, which contains the documents. [Required] [Filter(multi eq)] [ORD]
	ExtendedProperties	Extended properties contain temporary (not persisted) values in the object instance. (Inherited from EntityObject.)
	GenerateSingleDocument	Create maximum one document when documents from this type are generated by parent documents (usually from another document type). [Required] [Default(false)]
	Id	The unique Id of the entity object (Inherited from EntityObject.)
	InvoicesOptions	List of InvoicesOption child objects, based on the Crm.Invoicing.InvoicesOption.DocumentType back reference
	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.)
	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	Notes for this DocumentType.
	Notifications	List of DocumentTypeNotification child objects, based on the General.DocumentTypeNotification.DocumentType back reference
	ObjectState	Gets the state of the domain object. (Overrides EditableDomainObjectObjectState.)
	OffersOptions	List of OffersOption child objects, based on the Crm.Presales.OffersOption.DocumentType back reference
	Printouts	List of Printout child objects, based on the General.Printout.DocumentType back reference
	Repository	Provides access to DocumentTypesRepository repository methods
	Routes	List of Route child objects, based on the Systems.Workflow.Route.DocumentType back reference
	SalesOrdersOptions	List of SalesOrdersOption child objects, based on the Crm.Sales.SalesOrdersOption.DocumentType back reference
	SchemaXML	Obsolete. Not used.
	Sequence	The sequence that will be used to give new numbers to the documents of this type. [Filter(multi eq)]
	Transaction	The EnterpriseOne transaction to which this object is attached. (Inherited from EnterpriseOneEntityObject.)
	TransitionalDocument	If checked determines that the documents from this type are automatically managed by the system and don't require management from the users. [Required] [Default(false)]
	TypeName	Description of the document type. [Required] [Filter(like)] [ORD]
	UserStatuses	List of DocumentTypeUserStatus child objects, based on the General.DocumentTypeUserStatus.DocumentType back reference

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.)
	GetEntityNameRepository	Gets the repository for document objects specified by EntityName.
	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