Click or drag to resize

Activity Class

Generic activity. Provides task management functionality. Activity can be one of Task, Communication or Meeting. Entity: Cm_Activities
Inheritance Hierarchy

Namespace:  Aloe.EnterpriseOne.Model.General.Contacts
Assembly:  Aloe.EnterpriseOne.Model (in Aloe.EnterpriseOne.Model.dll) Version: 20.1.3.5
Syntax
public class Activity : Document

The Activity type exposes the following members.

Constructors
  NameDescription
Public methodActivity
Initializes a new instance of the Activity class with specific ObjectTransaction
Top
Properties
  NameDescription
Public propertyAccessKey
The access key, containing the user permissions for this document. null means that all users have unlimited permissions
(Inherited from Document.)
Public propertyActivityId
Gets the Id of the activity row, related to the domain object
Public propertyAdjustedDocument
The primary document, which the current document adjusts. null when this is not an adjustment document
(Inherited from Document.)
Public propertyAdjustmentNumber
Consecutive number of the correction that this document is applying to the adjusted document. [Required]
(Inherited from Document.)
Public propertyAdjustmentTime
Date/time when the document last has been adjusted by corrective document
(Inherited from Document.)
Public propertyAdjustmentUser
The user who adjusted the document
(Inherited from Document.)
Public propertyAssignedToUser
The user to which this document is assigned for handling. null means that the document is not assigned to specific user
(Inherited from Document.)
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 propertyComments
List of DocumentComment child objects, based on the DocumentComment.Document back reference
(Inherited from Document.)
Public propertyCompleteTime
Exact time, when the document was last completed[Filter(ge;le)]
(Inherited from Document.)
Public propertyContactPerson
The contact person, from the side of the Target Party. [Filter(multi eq)]
Public propertyCreationTime
Date/Time when the document was created [Required][Filter(ge;le)]
(Inherited from Document.)
Public propertyCreationUser
The login name of the user, who created the document [Required][Filter(like)]
(Inherited from Document.)
Public propertyCurrencyDirectory
The currency directory, containing all the convertion rates, used by the document. null means that the document does not need currency convertions
(Inherited from Document.)
Public propertyCustomProperties
Gets the custom properties of the object.
(Inherited from EnterpriseOneEntityObject.)
Public propertyDeadlineTime
The deadline for the task. null if there is no deadline. [Filter(ge;le)]
Public propertyDistributedAmounts
List of DocumentDistributedAmount child objects, based on the DocumentDistributedAmount.Document back reference
(Inherited from Document.)
Public propertyDocumentDate
The date on which the document was issued [Required][Filter(eq;ge;le)][ORD]
(Inherited from Document.)
Public propertyDocumentId
Gets the Id of the document row, related to the domain object
(Inherited from Document.)
Public propertyDocumentNo
Document number, unique within Document_Type_Id [Required][Filter(eq;like)][ORD]
(Inherited from Document.)
Public propertyDocumentNotes
Notes for this Document
(Inherited from Document.)
Public propertyDocumentText
Gets the document display text ({DocumentTypeName} {DocumentNo}).
(Inherited from Document.)
Public propertyDocumentType
The user defined type of the document. Determines document behaviour, properties, additional amounts, validation, generations, etc. [Required]
(Inherited from Document.)
Public propertyDocumentVersion
[Filter(eq;ge;le)]
(Inherited from Document.)
Public propertyEndTime
Currently planned ending time of the task. [Filter(ge;le)]
Public propertyEnterpriseCompany
The enterprise company which issued the document [Required]
(Inherited from Document.)
Public propertyEnterpriseCompanyLocation
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
(Inherited from Document.)
Public propertyEntityName
The entity name of the document equal to the entity name of the document type.[Filter(eq)] [ORD]
(Inherited from Document.)
Public propertyExtendedProperties
Extended properties contain temporary (not persisted) values in the object instance.
(Inherited from EntityObject.)
Public propertyFileAttachments
List of DocumentFileAttachment child objects, based on the DocumentFileAttachment.Document back reference
(Inherited from Document.)
Public propertyFromCompanyDivision
The division of the company, issuing the document. null when the document is not issued by any specific division
(Inherited from Document.)
Public propertyFromParty
The party which issued the document [Required]
(Inherited from Document.)
Public propertyId
The unique Id of the entity object
(Inherited from EntityObject.)
Public propertyIsAdjustingDocument
Gets a value indicating whether this instance is adjusting document.
(Inherited from Document.)
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 DocumentIsLoaded.)
Public propertyIsReleased
True if the document is not void and its state is released or greater. [Required] [Default(false)] [Filter(eq)] [ReadOnly]
Public propertyIsSingleExecution
Specifies whether the document is a single execution of its order document. [Required] [Default(false)] [Filter(eq)] [ReadOnly]
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 propertyLineAmounts
List of DocumentLineAmount child objects, based on the DocumentLineAmount.Document back reference
(Inherited from Document.)
Public propertyMasterDocument
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]
(Inherited from Document.)
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 propertyNotes
Notes for this Activity.
Public propertyObjectState
Gets the state of the domain object.
(Overrides DocumentObjectState.)
Public propertyOwnerParty
The party that owns the task. Initially this is the party that has created the task. [Required] [Filter(multi eq)]
Public propertyParent
In a multi-document tree, this is the direct parent document. If this is the root it is null
(Inherited from Document.)
Public propertyParentDocumentRelationshipType
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'.
(Inherited from Document.)
Public propertyParticipants
List of ActivityParticipant child objects, based on the General.Contacts.ActivityParticipant.Activity back reference
Public propertyPlannedDurationMinutes
Total planned duration of the activity, regardless of the current execution status. [Filter(ge;le)]
Public propertyPlanningOnly
Indicates that the document is used only for planning (and as consequence its state cannot be greater than Planned) [Required]
(Inherited from Document.)
Public propertyPrimeCauseDocument
The document that is the prime cause for creation of the current document
(Inherited from Document.)
Public propertyPrints
List of DocumentPrint child objects, based on the DocumentPrint.Document back reference
(Inherited from Document.)
Public propertyPriority
Priority on the scale from 1 (least important) to 5 (very important). [Required] [Default(3)]
Public propertyPrivate
True if the task is visible only to its owner; false if this is publicly visible task. [Required] [Default(false)]
Public propertyProjectTask
The project task for which the work is performed. null when the activity is not related to a project task. [Filter(multi eq)]
Public propertyReadOnly
True - the document is read only; false - the document is not read only [Required]
(Inherited from Document.)
Public propertyReferenceDate
The date to which this document refers, i.e. when the action really occurred. If null, Document_Date is taken [Filter(ge;le)]
(Inherited from Document.)
Public propertyReferenceDocumentNo
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)]
(Inherited from Document.)
Public propertyReleaseTime
Exact time, when the document was first released [Filter(ge;le)]
(Inherited from Document.)
Public propertyReminders
List of Reminder child objects, based on the General.Contacts.Reminder.Activity back reference
Public propertyReminderTime
When to snooze to the owner to remind him for the task. This default reminder is copied to and managed by the Reminders entity.
Public propertyRepository
Provides access to ActivitiesRepository repository methods
Public propertyResources
List of ActivityResource child objects, based on the General.Contacts.ActivityResource.Activity back reference
Public propertyResponsibleParty
Who is responsible for executing the task. Initially this is the owner of the task. [Required] [Filter(multi eq)]
Public propertyResponsiblePerson
The person that is responsible for this order or transaction. It could be the sales person, the orderer, etc.
(Inherited from Document.)
Public propertyReverseOfDocument
The document which the current document is reverse of
(Inherited from Document.)
Public propertySequence
The sequence that will be used to give new numbers to the documents of this type
(Inherited from Document.)
Public propertyStartTime
Currently planned starting time of the task. [Required] [Default(Now)] [Filter(ge;le)]
Public propertyState
0=New;5=Corrective;10=Computer Planned;20=Human Planned;30=Released;40=Completed;50=Closed [Required][Filter(eq;ge;le)]
(Inherited from Document.)
Public propertyStateChanges
List of DocumentStateChange child objects, based on the DocumentStateChange.Document back reference
(Inherited from Document.)
Public propertySubject
Task primary subject (required). [Required] [Filter(eq;like)]
Public propertySystemType
T=Task; C=Communication; M=Meeting. [Required]
Public propertyTargetParty
External participant or target of the task. [Filter(multi eq)]
Public propertyToCompanyDivision
The division of the company, receiving the document. null when the document is not received by any specific division
(Inherited from Document.)
Public propertyToParty
The party which should receive the document
(Inherited from Document.)
Public propertyTransaction
The EnterpriseOne transaction to which this object is attached.
(Inherited from EnterpriseOneEntityObject.)
Public propertyUserStatus
The user status of this document if applicable for this document type. null means unknown or not yet set
(Inherited from Document.)
Public propertyVersions
List of DocumentVersion child objects, based on the DocumentVersion.Document back reference
(Inherited from Document.)
Public propertyVoid
True if the document is null and void [Required][Filter(eq)]
(Inherited from Document.)
Public propertyVoidReason
Reason for voiding the document, entered by the user
(Inherited from Document.)
Public propertyVoidTime
Date/time when the document has become void
(Inherited from Document.)
Public propertyVoidUser
The user who voided the document
(Inherited from Document.)
Top
Methods
  NameDescription
Public methodChangeState
Changes the document state to the specified new state
(Inherited from Document.)
Public methodCheckFreeTime
Checks the free time.
Public methodComplete
Changes the document state to Completed with all Release-ed sub-documents
(Inherited from Document.)
Public methodCreateAdjustmentDocument
Creates an adjustment document that doesn't adjust anything. Can be modified and saved.
(Inherited from Document.)
Public methodDelete
Deletes the domain object.
(Overrides DocumentDelete.)
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 methodGenerateLeaseContract
Generates the lease contract.
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 methodGetAllParentDocuments
Gets all parent documents, traversing the parent document chain by using the Parent property.
(Inherited from Document.)
Public methodGetHashCode
Returns a hash code for this instance.
(Inherited from EntityObject.)
Public methodGetPrintout
Gets a document printout as a file. The returned value is Base64 string representation of the file contents.
(Inherited from Document.)
Public methodGetRelatedObjectsForValidation
Gets the related objects which would need validation upon validation of this object.
(Inherited from EntityObject.)
Public methodStatic memberGetSystemSubject
Forms a string that is used as a Subject by the system if user hasn't provided one.
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 methodMakeVoid
Makes the document void. The operation is irreversible.
(Inherited from Document.)
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 methodMoveToFreeTime
Moves to free time.
Public methodRecalculate
The document and all of its owned objects will be altered to become valid.
(Inherited from Document.)
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