Activity Class |
Namespace: Omada.OE.Model
[SerializableAttribute] public class Activity : DataObject, ICloneable, IProcessElement, IObjectWithId
The Activity type exposes the following members.
Name | Description | |
---|---|---|
![]() | ActiveTime |
Contains the date when the activity last reached state=active
Attrivbute is readonly.
|
![]() | ActivityLinks |
Contains the activities which activity links to.
A link lead to that an assignee is updated automatically on linked activities.
Links are not always loaded - if not ActivityLinks = null.
|
![]() | ActivityType | |
![]() | AffectsPercentComplete |
If set, the completion of the process will affect the percent complete attribute if the process.
|
![]() | AssigneeConstraints |
Contains the contraints related to the activity.
A contraint means that two activites cannot be executed by the same person.
Constraints are not always loaded - if not AssigneeConstraints = null.
|
![]() | Assignees |
Specifies the assignees for the activity.
Use AssigneesInfoAvailable to determine whether the information is resolved/loaded.
|
![]() | AssigneesInfoAvailable |
Returns true if the Assignees has been populated for the activity.
|
![]() | AutoAccept |
Defines whether (a workitem for) the activity can be auth accepted when the user opens the workitem.
AutoAccept is only used when
* The activity is assigned to an individual (not a group) or the activity is a voting activity
* The activity (the workitem) is not already accepted/rejected
|
![]() | AvailableInfo |
Contains information about which attributes are available on the DataObject.
If for instance the attribute DataExchangeConfigId is used and the information is not laoded, an exception is thrown.
It is only used for DataObject instances which are loaded from the database.
For newly created objects, all attributes are available.
The different flags in the load options determines which attributes are available.
Use IsInfoAvailable() to discover which attributes are available.
(Inherited from DataObject.) |
![]() | ChangeTime |
This ChangeTime property is taken from the tblDataObject table column ChangeTime, which
is not necessarily the same time as the CreateTime of the newest DataObjectVersion
since the column can be updated independently for ILM integration purposes.
(Inherited from DataObject.) |
![]() | CompleteTime |
Contains the date when the object was completed.
It is only relevant for Activity and Process object instances.
The information is populated here due to filter and sorting features.
(Inherited from DataObject.) |
![]() | CreatedBy |
UserID of the User who created the object.
(Inherited from DataObject.) |
![]() | CreateTime |
Date when the object was created.
(Inherited from DataObject.) |
![]() | CurrentVersion |
Returns the current object version as defined in the database.
(Inherited from DataObject.) |
![]() | Deleted |
Returns true if the object is deleted.
(Inherited from DataObject.) |
![]() | DeletedBy |
User ID if the user who deleted the object
(Inherited from DataObject.) |
![]() | DeleteTime |
Date when object was deleted
(Inherited from DataObject.) |
![]() | DisplayName |
Contains the DisplayName of the data object.
The DisplayName is formatted using the DisplayNameFormat of the data object type.
If the DisplayNameFormat is empty, the DisplayName contains the name of the data object type and the number.
(Inherited from DataObject.) |
![]() | FileAttachments |
FilesAttachments contains the files which are attached to the DataObject.
FilesAttachments is not always populated (according to load options)
(Inherited from DataObject.) |
![]() | FixedFields |
Contains a number of read-only FixedFields.
The available fields are determined by the DataObjectType and on the load options.
Use EnumUtils.FixedFieldRequiresExplicitLoading() to discover which field that may be available in the collection.
(Inherited from DataObject.) |
![]() | Form |
The Form object related to the activity
|
![]() | FormFieldStates |
Contains overrides the the Form field settings
The overrides are not always loaded - only if FormFieldStates != null.
|
![]() | FormId |
The ID of the form related to the activity
|
![]() | Id |
The unique id of the data object.
(Inherited from DataObject.) |
![]() | InheritsSecurity |
Returns true if the object inherits it security from another object.
(Inherited from DataObject.) |
![]() | ItemInt32 |
Retriever/assigner of values for a property.
The data type of a value depends on the property type and data type:
Value property - Text: string
Value property - Integer: int
Value property - DateTime: DateTime
Value property - Decimal: double
Value property - Boolean: bool
Value property - Hyperlink: string
Value property - TimeSpan: TimeSpan
Value property - MultiLangText: string (value in active user's language)
Value property - Xml: string
Set property: int
Reference property: int
(Inherited from DataObject.) |
![]() | ItemString |
Retriever/assigner of values for a property.
The data type of a value depends on the property type and data type:
Value property - Text: string
Value property - Integer: int
Value property - DateTime: DateTime
Value property - Decimal: double
Value property - Boolean: bool
Value property - Hyperlink: string
Value property - TimeSpan: TimeSpan
Value property - MultiLangText: string (value in active user's language)
Value property - Xml: string
Set property: int
Reference property: int
(Inherited from DataObject.) |
![]() | LastVersion |
Returns the last version in the Versions collection. It may be a yet unsaved version.
(Inherited from DataObject.) |
![]() | LogEntries |
Contains the list of activity logs related to the activity.
Listen is sorted by changetime (ascending)
LogEntries is not always populated.
|
![]() | Number |
Contains the Number of the data object (which was taken from a sequence when it was created).
(Inherited from DataObject.) |
![]() | ParentId |
ParentId contains the ID of the parent DataObject.
For new DataObjects the ParentId is 0.
ParentId can and may only be set when creating a new DataObject where object
must be put a certain place in the tree structure.
If the object is the root of the tree structure, then ParentId = Id.
(Inherited from DataObject.) |
![]() | PercentComplete |
The estimated percent complete of the entire process when this activity completes.
|
![]() | Process |
The Process object of the activity.
The process object is not always available. If not, Process is null.
|
![]() | ProcessId |
The ID of the related process.
|
![]() | SecurityObject |
SecurityObject is null if the object has not been loaded.
It is only legal to change the SecurityObject if InheritsSecurity=false
since the SecurityObject instanse may be used on other DataObjects.
Use BreakSecurityInheritance to remove the inheritance.
(Inherited from DataObject.) |
![]() | SecurityObjectId |
Contains the ID for the DataObject which defines the security for the DataObject
(Inherited from DataObject.) |
![]() | SpecialType |
Returns true if the DataObject is of a special (built-in) type like User, UserGroup etc.
(Inherited from DataObject.) |
![]() | State |
The current state of the Activity
|
![]() | Template |
Defined whether the object is a template object.
It is applicable for process templates, activity templates and process target templates.
(Inherited from DataObject.) |
![]() | TemplateId |
TemplateId contains the ID of the activity from which this obect has been copied (cloned)
TemplateId is 0 if the activity is a template itself.
TemplateId can be 0 for instance activities if create after process instantiation.
|
![]() | TemplateObjectId |
If an object is cloned from a template object, this field contains the ID of the template.
(Inherited from DataObject.) |
![]() | Transitions |
Collection of transitions pointing to/from the activity.
|
![]() | TypeId |
ID of the data object type.
(Inherited from DataObject.) |
![]() | TypeName |
System name of the data object type.
Can be null (depending on which constructor is used) when creating a new data object (until it is saved).
(Inherited from DataObject.) |
![]() | TypeUId |
UID of the data object type.
Can be zero (depending on which constructor is used) when creating a new data object (until it is saved).
(Inherited from DataObject.) |
![]() | UId |
The cross-deployments unique id of the data object.
(Inherited from DataObject.) |
![]() | VotingUnit |
Voting unit for Activity
|
![]() | WorkItems |
Collection of workitems related to the activity (for one or more users)
the list is sorted by (workitem) id.
|
![]() | WorkWeekId |
Defines the workweek used for calculation of the duration.
|
Name | Description | |
---|---|---|
![]() | AddVersion(Boolean, DataObjectType) |
Adds a new DataObjevtVersion object the Versions collection.
If copyValues is true, all property values on the current version are copied to the new version.
(Inherited from DataObject.) |
![]() | AddVersion(Boolean, Boolean, DataObjectType) |
If a data object must be modified then a new version must be added first.
This method adds a new version to the data object.
(Inherited from DataObject.) |
![]() | AssignPropertyValue |
Tip: use the indexer property to access property values instead of using this method.
Assigns a property value to the LastVersion of the object.
The value can be of type:
string, int, datetime, double, bool, timespan, AppStringContainer, SetPropertyValue, ReferencePropertyValue or null.
The value type is dependant on the DataType of the property
(Inherited from DataObject.) |
![]() | AssignReferencePropertyValue |
Assigns a reference property on LastVersion.
(Inherited from DataObject.) |
![]() | AssignReferencePropertyValues |
Assigns a reference property on LastVersion.
Tip: use the indexer property to access property values instead of using this method.
(Inherited from DataObject.) |
![]() | BreakSecurityInheritance |
Breaks the enheritance of security.
If InheritsSecurity=true no adjustments must be made to the security.
This method is used to set InheritsSecurity=false.
(Inherited from DataObject.) |
![]() | CheckAndAddVersion(Boolean) |
Adds a version only of the LastVersion object is already stored in the database.
(Inherited from DataObject.) |
![]() | CheckAndAddVersion(Boolean, DataObjectType) |
Adds a version only if the LastVersion object is already stored in the database.
(Inherited from DataObject.) |
![]() | Clone | (Overrides DataObjectClone.) |
![]() | FormatTemplateText |
Formats the object to a string using a template string where attributes a replaced.
(Inherited from DataObject.) |
![]() | GetActiveUserAcceptance |
Returns the acceptance value for the active user.
The method depends on on the following fields:
* WorkItems collection
* A workitem exists for the aktive user
If not, NotAvailable is returned.
|
![]() | GetMultiLanguagePropertyValue |
Returns multi language property value in provided language.
(Inherited from DataObject.) |
![]() | GetObjectKey |
Returns the key value of the data object.
the key property comes from the typen, but it must be provided for performance reasons.
If key property is 0 the display name is returned.
Returns null if the object does not have a value for the provided key (value) property.
(Inherited from DataObject.) |
![]() | GetOutgoingTransitionByIndex |
Returns the outgoing transition for the activity based on the provided index.
|
![]() | GetPropertyValue(Int32) |
Returns the value of a particular property on the newest data object version.
The value can be of the following type::
string, int, datetime, double, bool, SetPropertyValue object or ReferencePropertyValue object.
It can also be null, if:
* The object does not have a current versionhar ingen current version
* The property was not found (its not on the type)'en blev ikke fundet (den er ikke på typen)
* The value has not been loaded (ValueAvailable=false)
* There are no value for theproperty
(can be caused by yhe property being added to the type after the object was created.)
* The identity user does not have access to the property
(Inherited from DataObject.) |
![]() | GetPropertyValue(Int32, IEnumerableInt32) | Obsolete.
Returns the value(s) of a Set property or a Reference property.
If the property is a Set property the Ids of the selected Set Property Values are returned.
If the property is a Reference property the Ids of the selected Data Objects are returned.
(Inherited from DataObject.) |
![]() | GetPropertyValue(Int32, Int32) | Obsolete.
Returns the value of a Value property with data type 'Integer' or a Set property or a Reference property.
If the property is a Set property the Id of the selected Set Property Value is returned.
If the Set property has more than one selected values then a random one of those is returned.
If the property is a Reference property the Id of the selected Data Object is returned.
If the Reference property has more than one selected values then a random one of those is returned.
(Inherited from DataObject.) |
![]() | GetPropertyValue(String, Boolean) | Obsolete.
Returns the value of a Value property with data type 'Boolean'.
(Inherited from DataObject.) |
![]() | GetPropertyValue(String, IEnumerableInt32) | Obsolete.
Returns the value(s) of a Set property or a Reference property.
If the property is a Set property the Ids of the selected Set Property Values are returned.
If the property is a Reference property the Ids of the selected Data Objects are returned.
(Inherited from DataObject.) |
![]() | GetPropertyValue(String, DateTime) | Obsolete.
Returns the value of a Value property with data type 'DateTime'.
(Inherited from DataObject.) |
![]() | GetPropertyValue(String, Double) | Obsolete.
Returns the value of a Value property with data type 'Decimal'.
(Inherited from DataObject.) |
![]() | GetPropertyValue(String, Guid) | Obsolete.
Returns the value of Set property.
The UId of the selected Set Property Value is returned.
If the Set property has more than one selected values then a random one of those is returned.
Throws an exception if:
- The property doesn't exist
- The property is not present in the data object type
- The property is not of the right type and data type
- The value of the property is not available (because it has not been loaded)
- The value of the property is not accessible due to security
(Inherited from DataObject.) |
![]() | GetPropertyValue(String, Int32) |
Returns the value of a Value property with data type 'Integer' or a Set property or a Reference property.
If the property is a Set property the Id of the selected Set Property Value is returned.
If the Set property has more than one selected values then a random one of those is returned.
If the property is a Reference property the Id of the selected Data Object is returned.
If the Reference property has more than one selected values then a random one of those is returned.
Throws an exception if:
- The property doesn't exist
- The property is not present in the data object type
- The property is not of the right type and data type
- The value of the property is not available (because it has not been loaded)
- The value of the property is not accessible due to security
(Inherited from DataObject.) |
![]() | GetPropertyValue(String, String) |
Returns the string value of a property.
If the property is a Value property it must be of data type 'Text' or 'MultiLangText'.
If the property is a Set property the Name of the (first) selected value is returned.
If the property is a Reference property the DisplayName of the (first) selected value is returned.
Throws an exception if:
- The property doesn't exist
- The property is not present in the data object type
- The property is not of the right type and data type
- The value of the property is not available (because it has not been loaded)
- The value of the property is not accessible due to security
(Inherited from DataObject.) |
![]() | GetPropertyValue(String, TimeSpan) | Obsolete.
Returns the value of a Value property with data type 'TimeSpan'.
(Inherited from DataObject.) |
![]() | GetPropertyValueByOdwMapping(String, DateTime) |
Returns the datetime value of a property by odw mapping.
If the property is a Value property it must be of data type DateTime.
(Inherited from DataObject.) |
![]() | GetPropertyValueByOdwMapping(String, String) |
Returns the string value of a property by odw mapping.
If the property is a Value property it must be of data type 'Text' or 'MultiLangText'.
If the property is a Set property the Name of the (first) selected value is returned.
If the property is a Reference property the DisplayName of the (first) selected value is returned.
Throws an exception if:
- The property doesn't exist
- The property is not present in the data object type
- The property is not of the right type and data type
- The value of the property is not available (because it has not been loaded)
- The value of the property is not accessible due to security
(Inherited from DataObject.) |
![]() | GetPropertyValuesT(Int32) |
Returns the value(s) for a property.
(Inherited from DataObject.) |
![]() | GetPropertyValuesT(String) |
Returns the value(s) for a property or a fixed field.
Not all fixed fields are supported - please refer to the PropertyValuesContainer class for details.
(Inherited from DataObject.) |
![]() | GetReferencePropertyValues(Int32) |
Returns a collection of ReferencePropertyValue objects from the current DataObjectVersion.
(Inherited from DataObject.) |
![]() | GetReferencePropertyValues(String) |
Returns a collection of ReferencePropertyValue objects from the current DataObjectVersion.
(Inherited from DataObject.) |
![]() | GetSinglePropertyValueT(Int32, T) |
Returns a single value for a property (fixed fields are not supported by this method).
(Inherited from DataObject.) |
![]() | GetSinglePropertyValueT(String, T) |
Returns a single value for a property or a fixed field.
Not all fixed fields are supported - please refer to the PropertyValuesContainer class for details.
(Inherited from DataObject.) |
![]() | GetSinglePropertyValueByOdwMappingT |
Returns a single value for a property or a fixed field based on ODW mapping.
Not all fixed fields are supported - please refer to the PropertyValuesContainer class for details.
(Inherited from DataObject.) |
![]() | HasProperty |
Returns true if the data object has the specified property.
(Inherited from DataObject.) |
![]() | IsAssigneesAvailable |
Returns true if Assignee data has been populated
|
![]() | IsInfoAvailable |
Returns true if the fields provided in infoFlags is available on the DataObject.
(Inherited from DataObject.) |
![]() | PassesFilter | |
![]() | PropertyChanged |
Returns true if the provided property has changed between
CurrentVersion and LastVersion.
If no currentversion is available, true is returned.
(Inherited from DataObject.) |
![]() | SetId |
Sets the internal ID of the object
(Inherited from DataObject.) |
![]() | SetPropertyValue |
Tip: use the indexer property to access property values instead of using this method.
Assigns a property value to the LastVersion of the object.
The value can be of type:
string, int, datetime, double, bool, timespan, AppStringContainer, SetPropertyValue, ReferencePropertyValue or null.
The value type is dependant on the DataType of the property
(Inherited from DataObject.) |
![]() | ToString |
Formats the object to a displayable string.
(Inherited from DataObject.) |
![]() | ToString(AppFormatInfo) |
Returns the string representation of the object.
(Inherited from DataObject.) |
![]() | UpdateDisplayName |
Updates data object display name.
(Inherited from DataObject.) |
Name | Description | |
---|---|---|
![]() | ObjectRetrievedFromCache |
Object was retrieved from a memory cache and not deserialized from the SQL cursor.
(Inherited from DataObject.) |
Name | Description | |
---|---|---|
![]() | ToBool |
Converts object to boolean.
(Defined by ObjectExtensions.) |
![]() | ToDateTime |
Converts object to DateTime.
(Defined by ObjectExtensions.) |
![]() | ToInt |
Converts object to integer.
(Defined by ObjectExtensions.) |
Name | Description | |
---|---|---|
![]() ![]() | IObjectWithDataVersion.GetDataVersion | (Inherited from DataObject.) |
![]() ![]() | IObjectWithGuid.GetGuid | (Inherited from DataObject.) |
![]() ![]() | IObjectWithId.GetId | (Inherited from DataObject.) |
![]() ![]() | IDataObjectDisplayName |
States the display name of the data object.
(Inherited from DataObject.) |
![]() ![]() | IDataObjectGetPropertyValue |
Returns the string value of a property.
If the property is a Value property it must be of data type 'Text' or 'MultiLangText'.
If the property is a Set property the Name of the (first) selected value is returned.
If the property is a Reference property the DisplayName of the (first) selected value is returned.
Throws an exception if:
- The property doesn't exist
- The property is not present in the data object type
- The property is not of the right type and data type
- The value of the property is not available (because it has not been loaded)
- The value of the property is not accessible due to security
(Inherited from DataObject.) |
![]() ![]() | IDataObjectGetPropertyValues |
Returns a dictionary with the property values of the data object.
The keys in the dictionary are the system names of the properties.
Not all properties are present in the dictionary. The following are excluded:
- Text properties with log
- Hyperlink properties
- Properties w. denied access
- Properties w. an inavailable value
The data type of the property value depends on the type and data type of the property:
- Set property: IEnumerable int of SetPropertyValue ids
- Reference property: IEnumerable<IReferencePropertyValue>
- Value property - Text: string - can be null
- Value property - Integer: int - can be null
- Value property - DateTime: DateTime - can be null
- Value property - Decimal : double - can be null
- Value property - Boolean : bool - can be null
- Value property - TimeSpan : TimeSpan - can be null
- Value property - Multilang. text : string with value in active user's language - can be null
(Inherited from DataObject.) |
![]() ![]() | IDataObjectId |
States the Id of the data object.
(Inherited from DataObject.) |
![]() ![]() | IDataObjectNumber |
States the Number of the data object.
(Inherited from DataObject.) |
![]() ![]() | IDataObjectParentId |
States the Id of the data object which is the parent of the data object.
(Inherited from DataObject.) |
![]() ![]() | IDataObjectTemplate |
States whether the data object is a template.
Template data objects are either: process templates, activity templates or target object templates.
(Inherited from DataObject.) |
![]() ![]() | IDataObjectTypeId |
States the data object type id of the data object.
(Inherited from DataObject.) |
![]() ![]() | IDataObjectUId |
States the UId of the data object.
(Inherited from DataObject.) |
![]() ![]() | IObjectContainingDataObjectGetDataObject |
Returns the DataObject
(Inherited from DataObject.) |
![]() ![]() | IObjectWithAttributesAddAttribute |
Adds an attribute - if it exists already the value is overwritten.
(Inherited from DataObject.) |
![]() ![]() | IObjectWithAttributesGetKeys |
Returns all the keys in the collection
(Inherited from DataObject.) |
![]() ![]() | IObjectWithAttributesGetValue |
Returns the value of an attribute.
If the attribute doesn't exist null is returned.
(Inherited from DataObject.) |
![]() ![]() | IObjectWithAttributesHasAttribute |
Returns whether an attribute exists.
(Inherited from DataObject.) |