Route Class

Contains document routes, which specify which document generation procedures will be run upon document events. Entity: Wf_Routes

Inheritance Hierarchy

SystemObject
  Aloe.SystemFrameworks.DomainDomainObject
    Aloe.SystemFrameworks.DomainEditableDomainObject
      Aloe.SystemFrameworks.DomainEntityObject
        Aloe.EnterpriseOne.Model.CoreEnterpriseOneEntityObject
          Aloe.EnterpriseOne.Model.Systems.WorkflowRoute

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

Syntax

C++

Copy

public class Route : EnterpriseOneEntityObject

Public Class Route
	Inherits EnterpriseOneEntityObject

public ref class Route : public EnterpriseOneEntityObject

type Route =  
    class
        inherit EnterpriseOneEntityObject
    end

The Route type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	ActivationDate	The date from which (including) the route is active. The date is matched against the document date of the generating document. [Required] [Default(Today)] [Filter(ge;le)]
	Active	True if the route is active, otherwise false. [Required] [Default(true)] [Filter(eq)]
	AllowedGenerationTypes	Determines the possible types of the generation of the destination document: A=Auto, M=Manual, B=Both (Auto and Manual). [Required] [Default("B")] [Filter(multi eq)]
	AllowObsoleteGeneration	Allows the usage of unsupported generation procedures (marked as obsolete). This is a user override of the system prohibition of the usage of obsolete procedures. [Required] [Default(false)]
	ChangingAttributes	Gets the attributes that are currently changing. Can be used in attribute change event handler to prevent stack overflow. (Inherited from EditableDomainObject.)
	ConditionEnterpriseCompany	The enterprise company for which this route is activated. [Filter(multi eq)]
	ConditionFilterXML	Contains filter condition, which the document must match in order to execute the route.
	ConditionStatesBitMask	The system states for which to execute the specified route. [Required] [Default(0)]
	ConditionUserStatus	The user-defined status, for which the document route is activated. [Filter(multi eq)]
	ConnectedPartyCondition	A - any party; C - connected party: to_party is enterprise company; U - unconnected party - not enterprise company;. [Required] [Default("A")]
	CustomProperties	Gets the custom properties of the object. (Inherited from EnterpriseOneEntityObject.)
	DeactivationDate	The date until (including) the route is active. The date is matched against the document date of the generating document. Null means the route does not have a deactivation date. [Filter(ge;le)]
	DestinationDocumentType	The type of the document, that will be generated by executing the route. [Filter(multi eq)]
	DestinationEnterpriseCompany	The enterprise company in which to generate the target document. [Filter(multi eq)]
	DestinationEnterpriseCompanyLocation	The enterprise company location in which to generate the target document. [Filter(multi eq)]
	DestinationState	0=New;10=Computer Planned;20=Human Planned;30=Released;40=Completed;50=Closed. [Required]
	DestinationUserStatus	The user defined status to set to the generated document. [Filter(multi eq)]
	DocumentType	The document type from which this route originates. Documents from this type generate sub-documents using this route. [Required] [Filter(multi eq)] [Owner]
	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.)
	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.)
	NegativeConditionFilterXml	The negative condition should NOT be matched by the document in order to execute the route.
	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 Route.
	ObjectState	Gets the state of the domain object. (Overrides EditableDomainObjectObjectState.)
	ParentDocumentRelationshipType	Determines the default relationship type between the generated document and the parent document. [Required] [Default("S")]
	ProcedureName	The system name of the generation procedure, which must be executed by the route. [Required]
	ProcessEvent	Event which triggers the route. Usually the event is change of state. Every document entity may define own custom events. [Required]
	ReadOnly	Indicates wheather the destination document shoul be read only. true - the destination document is read only. [Required] [Default(false)]
	Repository	Provides access to RoutesRepository repository methods
	SalesOrderPaymentOrdersTemplates	List of SalesOrderPaymentOrdersTemplate child objects, based on the Crm.Sales.SalesOrderPaymentOrdersTemplate.Route back reference
	TemplateRouteLinks	List of TemplateRouteLink child objects, based on the Finance.Accounting.TemplateRouteLink.Route back reference
	Templates	List of Template child objects, based on the Finance.Accounting.Template.Route back reference
	Transaction	The EnterpriseOne transaction to which this object is attached. (Inherited from EnterpriseOneEntityObject.)

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.Systems.Workflow Namespace