Click or drag to resize

ScheduledDocumentEvent Class

Contains postponed events, which will be executed later. Usually these are large number of recalculation events, resulting from other events. For example, releasing a cost correction, publishes postponed events for all affected documents. Entity: Gen_Scheduled_Document_Events
Inheritance Hierarchy

Namespace:  Aloe.EnterpriseOne.Model.General
Assembly:  Aloe.EnterpriseOne.Model (in Aloe.EnterpriseOne.Model.dll) Version: 20.1.3.5
Syntax
public class ScheduledDocumentEvent : EnterpriseOneEntityObject

The ScheduledDocumentEvent type exposes the following members.

Constructors
  NameDescription
Public methodScheduledDocumentEvent
Initializes a new instance of the ScheduledDocumentEvent class with specific ObjectTransaction
Top
Properties
  NameDescription
Public propertyCancelled
When true, specifies that this document event has been cancelled (either manually or in respect to another event) and will not be executed. [Required] [Default(false)] [Filter(eq)]
Public propertyChangingAttributes
Gets the attributes that are currently changing. Can be used in attribute change event handler to prevent stack overflow.
(Inherited from EditableDomainObject.)
Public propertyCreationTime
Date and time when the ScheduledDocumentEvent was created. [Required] [Default(Now)] [ReadOnly]
Public propertyCustomProperties
Gets the custom properties of the object.
(Inherited from EnterpriseOneEntityObject.)
Public propertyDocument
The document for which the event will be processed. [Required] [Filter(multi eq)] [ReadOnly]
Public propertyDocumentEvent
The type of the document event that is scheduled to be processed. [Required] [ReadOnly]
Public propertyExtendedProperties
Extended properties contain temporary (not persisted) values in the object instance.
(Inherited from EntityObject.)
Public propertyId
The unique Id of the entity object
(Inherited from EntityObject.)
Public propertyIsGhost
Returns true when the object is a ghost object
(Inherited from EntityObject.)
Public propertyIsLoaded
Gets a value indicating whether the associated data for this domain object is loaded.
(Overrides EntityObjectIsLoaded.)
Public propertyItemString
Gets or sets the value of a data attribute
(Inherited from DomainObject.)
Public propertyItemIDataAttribute
Gets or sets the value of a data attribute
(Inherited from DomainObject.)
Public propertyLastProcessStatus
Status/information of the last attemp to process the event. Usually shows the cause in case of failure. [ReadOnly]
Public propertyLastProcessTime
The time of the last attempt to process the event. [ReadOnly]
Public propertyNoEvents
Turns on "No events" mode and returns a class, that will turn it off when Disposed. See remarks for more info.
(Inherited from DomainObject.)
Public propertyObjectState
Gets the state of the domain object.
(Overrides EditableDomainObjectObjectState.)
Public propertyProcessed
Indicates wheather the event is already processed or not. [Required] [Default(false)] [Filter(eq)] [ReadOnly]
Public propertyRepository
Provides access to ScheduledDocumentEventsRepository repository methods
Public propertySourceDocument
The document that has caused this event to be scheduled. [Required] [Filter(multi eq)] [ReadOnly]
Public propertyState
The state of the document for which the event will be processed. [Required] [ReadOnly]
Public propertyTransaction
The EnterpriseOne transaction to which this object is attached.
(Inherited from EnterpriseOneEntityObject.)
Top
Methods
  NameDescription
Public methodDelete
Deletes the domain object.
(Overrides EntityObjectDelete.)
Public methodDuplicateObject
Creates a copy of the object.
(Inherited from EntityObject.)
Public methodEquals(Object)
Determines whether the specified Object, is equal to this instance.
(Inherited from EntityObject.)
Public methodEquals(EntityObject)
Indicates whether the current object is equal to another object of the same type.
(Inherited from EntityObject.)
Public methodExecuteBusinessRules
Executes all business rules for the object for the specified BusinessEvent. The validation fails are saved in the event.
(Inherited from EditableDomainObject.)
Public methodGetAggregateParent
Gets the aggregate parent of this entity object. If this is the aggregate root the return value is null.
(Inherited from EntityObject.)
Public methodGetAggregateRoot
Gets the aggregate root entity object. If the entity does not have aggregate parent reference aggregate root is this entity object.
(Inherited from EntityObject.)
Public methodGetHashCode
Returns a hash code for this instance.
(Inherited from EntityObject.)
Public methodGetRelatedObjectsForValidation
Gets the related objects which would need validation upon validation of this object.
(Inherited from EntityObject.)
Public methodIssueWarning(String)
Issues a warning with the specified message.
(Inherited from EditableDomainObject.)
Public methodIssueWarning(ExpressionFuncString, Object)
Issues a warning with the specified message. The message can contain standard string placeholders.
(Inherited from EditableDomainObject.)
Public methodMatchesFilter(DataAccessFilter)
Returns true if this entity object matches the specified filter.
(Inherited from EnterpriseOneEntityObject.)
Public methodMatchesFilter(DataAccessFilter, IBufferRow)
Matches the filter against the specified row and returns the result of the match.
(Inherited from EnterpriseOneEntityObject.)
Public methodProcess
Processes this ScheduledDocumentEvent.
Public methodRefresh
Refreshes this instance with data from data source. Only objects with ObjectState equal to Unchanged are refreshed.
(Inherited from EntityObject.)
Public methodToString
Returns a String that represents this instance.
(Inherited from EntityObject.)
Public methodToString(String)
Returns a String that represents this instance.
(Inherited from EntityObject.)
Public methodTryGet
Tries to get the specified attribute and returns it or null, when it is not found.
(Inherited from DomainObject.)
Top
Extension Methods
  NameDescription
Public Extension MethodFillAggregateMissingDefaults
Recalculates the default values for all objects in the aggregate.
(Defined by EntityObjectExtensions.)
Public Extension MethodFillMissingDefaults
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.)
Public Extension MethodFormatString
Converts the object to string based on the format specified.
(Defined by FormatStringExtensions.)
Public Extension MethodGetExtensibleDataObject
Gets the extensible data object related to the entity object. Can return null if such ExtensibleDataObject doesn't exist.
(Defined by ExtensibleDataObjectExtensions.)
Public Extension MethodGetOrCreateExtensibleDataObject
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.)
Public Extension MethodRecalculateMasterAttributes
Recalculates the values of a master attributes in a master-detail relationship.
(Defined by EntityObjectExtensions.)
Public Extension MethodRecalculateMissingValues
Recalculates the missing values using the first reactive expression of the attributes.
(Defined by EntityObjectExtensions.)
Top
See Also