DataObject Properties |
The DataObject type exposes the following members.
Name | Description | |
---|---|---|
![]() | 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.
|
![]() | 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.
|
![]() | 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.
|
![]() | CreatedBy |
UserID of the User who created the object.
|
![]() | CreateTime |
Date when the object was created.
|
![]() | CurrentVersion |
Returns the current object version as defined in the database.
|
![]() | Deleted |
Returns true if the object is deleted.
|
![]() | DeletedBy |
User ID if the user who deleted the object
|
![]() | DeleteTime |
Date when object was deleted
|
![]() | 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.
|
![]() | FileAttachments |
FilesAttachments contains the files which are attached to the DataObject.
FilesAttachments is not always populated (according to load options)
|
![]() | 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.
|
![]() | Id |
The unique id of the data object.
|
![]() | InheritsSecurity |
Returns true if the object inherits it security from another object.
|
![]() | 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
|
![]() | 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
|
![]() | LastVersion |
Returns the last version in the Versions collection. It may be a yet unsaved version.
|
![]() | Number |
Contains the Number of the data object (which was taken from a sequence when it was created).
|
![]() | 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.
|
![]() ![]() | RootName |
Return "Root"
|
![]() | 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.
|
![]() | SecurityObjectId |
Contains the ID for the DataObject which defines the security for the DataObject
|
![]() | SpecialType |
Returns true if the DataObject is of a special (built-in) type like User, UserGroup etc.
|
![]() | Template |
Defined whether the object is a template object.
It is applicable for process templates, activity templates and process target templates.
|
![]() | TemplateObjectId |
If an object is cloned from a template object, this field contains the ID of the template.
|
![]() | TypeId |
ID of the data object type.
|
![]() | 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).
|
![]() | 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).
|
![]() | UId |
The cross-deployments unique id of the data object.
|
Name | Description | |
---|---|---|
![]() ![]() | IDataObjectDisplayName |
States the display name of the data object.
|
![]() ![]() | IDataObjectId |
States the Id of the data object.
|
![]() ![]() | IDataObjectNumber |
States the Number of the data object.
|
![]() ![]() | IDataObjectParentId |
States the Id of the data object which is the parent of the data object.
|
![]() ![]() | IDataObjectTemplate |
States whether the data object is a template.
Template data objects are either: process templates, activity templates or target object templates.
|
![]() ![]() | IDataObjectTypeId |
States the data object type id of the data object.
|
![]() ![]() | IDataObjectUId |
States the UId of the data object.
|