UserGroup Class

Specifies the authentication level required for a user to utilize a membership of the group. AuthLevel is ignored for personal groups.

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.

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.

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.

UserID of the User who created the object.

Date when the object was created.

Returns the current object version as defined in the database.

Returns true if the object is deleted.

User ID if the user who deleted the object

Date when object was deleted

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.

FilesAttachments contains the files which are attached to the DataObject. FilesAttachments is not always populated (according to load options)

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.

The unique id of the data object.

Returns true if the object inherits it security from another object.

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

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

Returns the last version in the Versions collection. It may be a yet unsaved version.

States the number of members of the group. Throws an error if the members of the group aren't available. Returns zero if the group is "Everyone".

Contains userids for the users who are members of the group. MemberIds can only be used if MembersAvailable is true - if not accessing it will cause an error.

Indicates whether the MemberIds collection is populated.

Contains the Number of the data object (which was taken from a sequence when it was created).

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.

Tells whether the group is a personal group for a user.

RoleIds contains id's of the authroles that the usergroup has. The authroleIds are sorted.

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.

Contains the ID for the DataObject which defines the security for the DataObject

Returns true if the DataObject is of a special (built-in) type like User, UserGroup etc.

Defined whether the object is a template object. It is applicable for process templates, activity templates and process target templates.

If an object is cloned from a template object, this field contains the ID of the template.

ID of the data object type.

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).

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).

The cross-deployments unique id of the data object.

Adds a user as member of the group. Throws an error if the members of the group aren't available. Throws an error if the group is "Everyone". Throws an error if the group is a personal group. Throws an error if the user is already a member of the group.

Adds a user as member of the group. Throws an error if the members of the group aren't available. Throws an error if the group is "Everyone". Throws an error if the group is a personal group. Throws an error if the user is already a member of the group - except if ignoreIfAlreadyMember is true.

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.

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.

Clears the existing members of the group and adds a number of users as members. Throws an error if the members of the group aren't available.

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

Assigns a reference property on LastVersion.

Assigns a reference property on LastVersion. Tip: use the indexer property to access property values instead of using this method.

Breaks the enheritance of security. If InheritsSecurity=true no adjustments must be made to the security. This method is used to set InheritsSecurity=false.

Adds a version only of the LastVersion object is already stored in the database.

Adds a version only if the LastVersion object is already stored in the database.

Throws an error if the members of the group aren't available. Throws an error if the group is "Everyone". Throws an error if the group is a personal group.

Formats the object to a string using a template string where attributes a replaced.

Returns multi language property value in provided language.

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.

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

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.

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.

Returns the value of a Value property with data type 'Boolean'.

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.

Returns the value of a Value property with data type 'DateTime'.

Returns the value of a Value property with data type 'Decimal'.

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

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

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

Returns the value of a Value property with data type 'TimeSpan'.

Returns the datetime value of a property by odw mapping. If the property is a Value property it must be of data type DateTime.

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

Returns the value(s) for a property.

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.

Returns a collection of ReferencePropertyValue objects from the current DataObjectVersion.

Returns a collection of ReferencePropertyValue objects from the current DataObjectVersion.

Returns a single value for a property (fixed fields are not supported by this method).

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.

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.

Returns true if the data object has the specified property.

Returns true if the fields provided in infoFlags is available on the DataObject.

Returns whether a specific user is a member of the group. If the group is "Everyone" the method always returns true without actually checking. Throws an error if the members of the group aren't available.

Returns whether one or more users are a member of the group. If the group is "Everyone" the method always returns true without actually checking. Throws an error if the members of the group aren't available.

Returns true if the provided property has changed between CurrentVersion and LastVersion. If no currentversion is available, true is returned.

Removes a user as member of the group. If the user is not a member of the group nothing happens. Throws an error if the members of the group aren't available. Throws an error if the group is "Everyone". Throws an error if the group is a personal group.

Sets the internal ID of the object

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

Returns whether the specified user group supports having an auth level.

Formats the object to a displayable string.

Updates data object display name.

Object was retrieved from a memory cache and not deserialized from the SQL cursor.

Converts object to boolean.

Converts object to DateTime.

Converts object to integer.

(Inherited from DataObject.)

(Inherited from DataObject.)

(Inherited from DataObject.)

States the display name of the data object.

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

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

States the Id of the data object.

States the Number of the data object.

States the Id of the data object which is the parent of the data object.

States whether the data object is a template. Template data objects are either: process templates, activity templates or target object templates.

States the data object type id of the data object.

States the UId of the data object.

Returns the DataObject

Adds an attribute - if it exists already the value is overwritten.

Returns all the keys in the collection

Returns the value of an attribute. If the attribute doesn't exist null is returned.

Returns whether an attribute exists.